AzureDevOpsDscNative.AzDoAreaPermission.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoAreaPermission",
  "kind": "resource",
  "version": "1.0.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "Defines a DSC resource for managing Azure DevOps area permissions.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "required": [
        "ProjectName"
      ],
      "title": "AzureDevOpsDscNative/AzDoAreaPermission",
      "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": "Specifies the name of the Azure DevOps project. This is a mandatory key property."
        },
        "AreaPath": {
          "type": "string",
          "title": "AreaPath",
          "description": "Specifies the path of the area within the Azure DevOps project. Defaults to `$null`."
        },
        "isInherited": {
          "type": "boolean",
          "title": "isInherited",
          "description": "Indicates whether the permissions are inherited. Defaults to `$true`."
        },
        "Permissions": {
          "items": {
            "type": "object"
          },
          "type": "array",
          "title": "Permissions",
          "description": "Specifies a hashtable array of permissions to be applied to the area."
        }
      },
      "description": "Defines a DSC resource for managing Azure DevOps area permissions.",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "additionalProperties": false,
      "type": "object"
    }
  }
}