AzureDevOpsDscNative.AzDoNotificationSubscription.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoNotificationSubscription",
  "kind": "resource",
  "version": "1.1.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing Azure DevOps notification subscriptions.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "additionalProperties": false,
      "type": "object",
      "description": "DSC resource for managing Azure DevOps notification subscriptions.",
      "title": "AzureDevOpsDscNative/AzDoNotificationSubscription",
      "$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."
        },
        "SubscriptionName": {
          "type": "string",
          "title": "SubscriptionName",
          "description": "A descriptive name for the subscription. This property is mandatory and serves as a key property for the resource."
        },
        "EventType": {
          "type": "string",
          "title": "EventType",
          "description": "The type of event to subscribe to. This is a key property. Common values include ms.vss-build.build-completed-failed-id, ms.vss-code.git-push, and ms.vss-code.git-pullrequest-created."
        },
        "ChannelType": {
          "type": "string",
          "title": "ChannelType",
          "description": "The delivery channel for notifications. Common values: EmailHtml, EmailPlainText."
        },
        "Subscriber": {
          "type": "string",
          "title": "Subscriber",
          "description": "The email address or group descriptor of the notification recipient. This is a mandatory property."
        },
        "ProjectName": {
          "type": "string",
          "title": "ProjectName",
          "description": "The project to scope the subscription to. If omitted, applies organization-wide."
        },
        "Filter": {
          "type": "object",
          "title": "Filter",
          "description": "A hashtable specifying event filter criteria."
        },
        "Enabled": {
          "type": "boolean",
          "title": "Enabled",
          "description": "Whether the subscription is active. Defaults to $true."
        }
      },
      "required": [
        "SubscriptionName",
        "EventType",
        "ChannelType",
        "Subscriber"
      ]
    }
  }
}