AzureDevOpsDscNative.AzDoAgentPool.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoAgentPool",
  "kind": "resource",
  "version": "1.1.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing Azure DevOps agent pools.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "description": "DSC resource for managing Azure DevOps agent pools.",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "title": "AzureDevOpsDscNative/AzDoAgentPool",
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "LookupResult": {
          "type": "object",
          "title": "LookupResult",
          "readOnly": true,
          "description": "The LookupResult property."
        },
        "PoolName": {
          "type": "string",
          "title": "PoolName",
          "description": "The name of the agent pool. This property is mandatory and serves as the key property for the resource."
        },
        "PoolType": {
          "type": "string",
          "enum": [
            "automation",
            "deployment"
          ],
          "title": "PoolType",
          "description": "The type of agent pool. Valid values are automation and deployment. Defaults to automation."
        },
        "AutoProvision": {
          "type": "boolean",
          "title": "AutoProvision",
          "description": "Whether to automatically provision the agent pool to new projects. Defaults to $false."
        },
        "AutoUpdate": {
          "type": "boolean",
          "title": "AutoUpdate",
          "description": "Whether to automatically update agents in the pool. Defaults to $true."
        },
        "IsHosted": {
          "type": "boolean",
          "title": "IsHosted",
          "description": "Whether the pool is a Microsoft-hosted pool. Microsoft-hosted pools cannot be created or removed through this resource, so this is only meaningful when reading existing pools. Defaults to $false."
        }
      },
      "required": [
        "PoolName"
      ],
      "type": "object",
      "additionalProperties": false
    }
  }
}