DomainResource

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-domain-resource-schema.json",
  "title": "DomainResource",
  "description": "A class representing a Domains resource.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-communication-services-domains-api-openapi.yml#/components/schemas/DomainResource",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/DomainProperties",
      "description": "The properties of a Domains resource.",
      "x-ms-client-flatten": true
    }
  },
  "allOf": [
    {
      "$ref": "#/$defs/TrackedResource"
    }
  ],
  "$defs": {
    "DnsRecord": {
      "type": "object",
      "description": "A class that represents a VerificationStatus record.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the DNS record. Example: TXT",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Name of the DNS record.",
          "readOnly": true
        },
        "value": {
          "type": "string",
          "description": "Value of the DNS record.",
          "readOnly": true
        },
        "ttl": {
          "type": "integer",
          "format": "int32",
          "description": "Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.",
          "readOnly": true
        }
      }
    },
    "DomainManagement": {
      "type": "string",
      "description": "Describes how a Domains resource is being managed.",
      "enum": [
        "AzureManaged",
        "CustomerManaged",
        "CustomerManagedInExchangeOnline"
      ],
      "x-ms-enum": {
        "name": "DomainManagement",
        "modelAsString": true,
        "values": [
          {
            "name": "AzureManaged",
            "value": "AzureManaged",
            "description": "AzureManaged"
          },
          {
            "name": "CustomerManaged",
            "value": "CustomerManaged",
            "description": "CustomerManaged"
          },
          {
            "name": "CustomerManagedInExchangeOnline",
            "value": "CustomerManagedInExchangeOnline",
            "description": "CustomerManagedInExchangeOnline"
          }
        ]
      }
    },
    "DomainProperties": {
      "type": "object",
      "description": "A class that describes the properties of a Domains resource.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/Domains_ProvisioningState",
          "description": "Provisioning state of the resource.",
          "readOnly": true
        },
        "dataLocation": {
          "type": "string",
          "description": "The location where the Domains resource data is stored at rest.",
          "readOnly": true
        },
        "fromSenderDomain": {
          "type": "string",
          "description": "P2 sender domain that is displayed to the email recipients [RFC 5322].",
          "readOnly": true
        },
        "mailFromSenderDomain": {
          "type": "string",
          "description": "P1 sender domain that is present on the email envelope [RFC 5321].",
          "readOnly": true
        },
        "domainManagement": {
          "$ref": "#/$defs/DomainManagement",
          "description": "Describes how a Domains resource is being managed."
        },
        "verificationStates": {
          "$ref": "#/$defs/DomainPropertiesVerificationStates",
          "description": "List of VerificationStatusRecord",
          "readOnly": true
        },
        "verificationRecords": {
          "$ref": "#/$defs/DomainPropertiesVerificationRecords",
          "description": "List of DnsRecord",
          "readOnly": true
        },
        "userEngagementTracking": {
          "$ref": "#/$defs/UserEngagementTracking",
          "description": "Describes whether user engagement tracking is enabled or disabled."
        }
      },
      "required": [
        "domainManagement"
      ]
    },
    "DomainPropertiesVerificationRecords": {
      "type": "object",
      "description": "List of DnsRecord",
      "properties": {
        "Domain": {
          "$ref": "#/$defs/DnsRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "SPF": {
          "$ref": "#/$defs/DnsRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DKIM": {
          "$ref": "#/$defs/DnsRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DKIM2": {
          "$ref": "#/$defs/DnsRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DMARC": {
          "$ref": "#/$defs/DnsRecord",
          "description": "A class that represents a VerificationStatus record."
        }
      }
    },
    "DomainPropertiesVerificationStates": {
      "type": "object",
      "description": "List of VerificationStatusRecord",
      "properties": {
        "Domain": {
          "$ref": "#/$defs/VerificationStatusRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "SPF": {
          "$ref": "#/$defs/VerificationStatusRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DKIM": {
          "$ref": "#/$defs/VerificationStatusRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DKIM2": {
          "$ref": "#/$defs/VerificationStatusRecord",
          "description": "A class that represents a VerificationStatus record."
        },
        "DMARC": {
          "$ref": "#/$defs/VerificationStatusRecord",
          "description": "A class that represents a VerificationStatus record."
        }
      }
    },
    "Domains_ProvisioningState": {
      "type": "string",
      "description": "Provisioning state of the resource.",
      "enum": [
        "Unknown",
        "Succeeded",
        "Failed",
        "Canceled",
        "Running",
        "Creating",
        "Updating",
        "Deleting",
        "Moving"
      ],
      "x-ms-enum": {
        "name": "Domains_ProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Unknown",
            "value": "Unknown",
            "description": "Unknown"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Canceled"
          },
          {
            "name": "Running",
            "value": "Running",
            "description": "Running"
          },
          {
            "name": "Creating",
            "value": "Creating",
            "description": "Creating"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "Deleting"
          },
          {
            "name": "Moving",
            "value": "Moving",
            "description": "Moving"
          }
        ]
      }
    },
    "TrackedResource": {
      "type": "object",
      "title": "Tracked Resource",
      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
      "properties": {
        "tags": {
          "type": "object",
          "description": "Resource tags.",
          "additionalProperties": {
            "type": "string"
          },
          "x-ms-mutability": [
            "read",
            "create",
            "update"
          ]
        },
        "location": {
          "type": "string",
          "description": "The geo-location where the resource lives",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        }
      },
      "required": [
        "location"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "UserEngagementTracking": {
      "type": "string",
      "description": "Describes whether user engagement tracking is enabled or disabled.",
      "enum": [
        "Disabled",
        "Enabled"
      ],
      "x-ms-enum": {
        "name": "UserEngagementTracking",
        "modelAsString": true,
        "values": [
          {
            "name": "Disabled",
            "value": "Disabled",
            "description": "Disabled"
          },
          {
            "name": "Enabled",
            "value": "Enabled",
            "description": "Enabled"
          }
        ]
      }
    },
    "VerificationStatus": {
      "type": "string",
      "description": "Status of the verification operation.",
      "enum": [
        "NotStarted",
        "VerificationRequested",
        "VerificationInProgress",
        "VerificationFailed",
        "Verified",
        "CancellationRequested"
      ],
      "x-ms-enum": {
        "name": "VerificationStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted",
            "description": "NotStarted"
          },
          {
            "name": "VerificationRequested",
            "value": "VerificationRequested",
            "description": "VerificationRequested"
          },
          {
            "name": "VerificationInProgress",
            "value": "VerificationInProgress",
            "description": "VerificationInProgress"
          },
          {
            "name": "VerificationFailed",
            "value": "VerificationFailed",
            "description": "VerificationFailed"
          },
          {
            "name": "Verified",
            "value": "Verified",
            "description": "Verified"
          },
          {
            "name": "CancellationRequested",
            "value": "CancellationRequested",
            "description": "CancellationRequested"
          }
        ]
      }
    },
    "VerificationStatusRecord": {
      "type": "object",
      "description": "A class that represents a VerificationStatus record.",
      "properties": {
        "status": {
          "$ref": "#/$defs/VerificationStatus",
          "description": "Status of the verification operation.",
          "readOnly": true
        },
        "errorCode": {
          "type": "string",
          "description": "Error code. This property will only be present if the status is UnableToVerify.",
          "readOnly": true
        }
      }
    }
  }
}