AzureDevOpsDscNative.AzDoCheckConfiguration.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoCheckConfiguration",
  "kind": "resource",
  "version": "1.1.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing pipeline check configurations.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "additionalProperties": false,
      "type": "object",
      "description": "DSC resource for managing pipeline check configurations.",
      "title": "AzureDevOpsDscNative/AzDoCheckConfiguration",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "LookupResult": {
          "type": "object",
          "title": "LookupResult",
          "readOnly": true,
          "description": "The LookupResult property."
        },
        "ProjectName": {
          "type": "string",
          "title": "ProjectName",
          "description": "The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource."
        },
        "TargetResourceName": {
          "type": "string",
          "title": "TargetResourceName",
          "description": "The name of the resource the check is attached to - an environment name, repository name or service connection name, depending on ResourceType. This property is mandatory."
        },
        "ResourceType": {
          "type": "string",
          "enum": [
            "environment",
            "repository",
            "endpoint"
          ],
          "title": "ResourceType",
          "description": "The type of resource. Valid values are environment, repository, and endpoint. This is a key property."
        },
        "CheckType": {
          "type": "string",
          "title": "CheckType",
          "description": "The type of check to configure (e.g., Task Check, Approval, ExclusiveLock). This is a key property."
        },
        "Settings": {
          "type": "object",
          "title": "Settings",
          "description": "A hashtable of check-specific configuration settings."
        },
        "TimeoutInMinutes": {
          "type": "integer",
          "title": "TimeoutInMinutes",
          "description": "How long the check can run before timing out. Defaults to 43200 (30 days)."
        },
        "Enabled": {
          "type": "boolean",
          "title": "Enabled",
          "description": "Whether the check is active. Defaults to $true."
        }
      },
      "required": [
        "ProjectName",
        "TargetResourceName",
        "ResourceType",
        "CheckType"
      ]
    }
  }
}