AzureDevOpsDscNative.AzDoAuditStream.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoAuditStream",
  "kind": "resource",
  "version": "1.1.0",
  "capabilities": [
    "set",
    "test",
    "get"
  ],
  "description": "DSC resource for managing Azure DevOps audit log streaming.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "additionalProperties": false,
      "type": "object",
      "description": "DSC resource for managing Azure DevOps audit log streaming.",
      "title": "AzureDevOpsDscNative/AzDoAuditStream",
      "$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."
        },
        "StreamName": {
          "type": "string",
          "title": "StreamName",
          "description": "The name of the audit stream. This property is mandatory and serves as the key property for the resource."
        },
        "ConsumerType": {
          "type": "string",
          "enum": [
            "AzureMonitorLogs",
            "Splunk",
            "AzureEventGrid",
            "AzureEventHub"
          ],
          "title": "ConsumerType",
          "description": "The type of audit log consumer. Valid values are AzureMonitorLogs, Splunk, AzureEventGrid, and AzureEventHub."
        },
        "ConsumerInputs": {
          "type": "object",
          "title": "ConsumerInputs",
          "description": "A hashtable of configuration inputs specific to the consumer type."
        },
        "Enabled": {
          "type": "boolean",
          "title": "Enabled",
          "description": "Whether the audit stream is active. Defaults to $true."
        }
      },
      "required": [
        "StreamName",
        "ConsumerType",
        "ConsumerInputs"
      ]
    }
  }
}