SqlServerDsc.SqlAgentAlert.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "SqlServerDsc/SqlAgentAlert",
  "kind": "resource",
  "version": "17.6.0",
  "capabilities": [
    "get",
    "test",
    "set"
  ],
  "description": "The `SqlAgentAlert` DSC resource is used to create, modify, or remove _SQL Server Agent_ alerts.",
  "author": "DSC Community",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "SqlServerDsc.psd1",
  "schema": {
    "embedded": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "properties": {
        "InstanceName": {
          "type": "string",
          "title": "InstanceName",
          "description": "The InstanceName property."
        },
        "ServerName": {
          "type": "string",
          "title": "ServerName",
          "description": "The ServerName property."
        },
        "Credential": {
          "type": "string",
          "title": "Credential",
          "description": "The Credential property."
        },
        "Protocol": {
          "type": "string",
          "enum": [
            "tcp",
            "np",
            "lpc"
          ],
          "title": "Protocol",
          "description": "The Protocol property."
        },
        "Port": {
          "type": "string",
          "title": "Port",
          "description": "The Port property."
        },
        "Reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Reasons",
          "readOnly": true,
          "description": "The Reasons property."
        },
        "Name": {
          "type": "string",
          "title": "Name",
          "description": "The name of the _SQL Server Agent_ alert."
        },
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "Specifies if the _SQL Server Agent_ alert should be present or absent. Default value is `'Present'`."
        },
        "Severity": {
          "type": "string",
          "title": "Severity",
          "description": "The severity of the _SQL Server Agent_ alert. Valid range is 1 to 25. Cannot be used together with **MessageId**."
        },
        "MessageId": {
          "type": "string",
          "title": "MessageId",
          "description": "The message id of the _SQL Server Agent_ alert. Valid range is 1 to 2147483647. Cannot be used together with **Severity**."
        }
      },
      "description": "The `SqlAgentAlert` DSC resource is used to create, modify, or remove _SQL Server Agent_ alerts.",
      "additionalProperties": false,
      "required": [
        "InstanceName",
        "Name"
      ],
      "title": "SqlServerDsc/SqlAgentAlert",
      "type": "object"
    }
  }
}