Microsoft Azure Communication Services Domains API

openapi: 3.2.0
info:
  title: Azure Communication Services Management Domains API
  version: '2026-03-18'
  description: REST API for Email Services/Domains/SuppressionLists
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Domains
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains
  : get:
      operationId: Domains_ListByEmailServiceResource
      tags:
      - Domains
      summary: List by EmailService
      description: Handles requests to list all Domains resources under the parent EmailServices resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResourceList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
  : get:
      operationId: Domains_Get
      tags:
      - Domains
      summary: Get
      description: Get the Domains resource and its properties.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Domains_CreateOrUpdate
      tags:
      - Domains
      summary: Create Or Update
      description: Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Resource 'DomainResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResource'
        '201':
          description: Resource 'DomainResource' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/DomainResource'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainResource'
        description: Parameters for the create or update operation
        required: true
    patch:
      operationId: Domains_Update
      tags:
      - Domains
      summary: Update
      description: Operation to update an existing Domains resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResource'
        '201':
          description: Resource 'DomainResource' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/DomainResource'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainRequestParameters'
        description: Parameters for the update operation
        required: true
    delete:
      operationId: Domains_Delete
      tags:
      - Domains
      summary: Delete
      description: Operation to delete a Domains resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/cancelVerification
  : post:
      operationId: Domains_CancelVerification
      tags:
      - Domains
      summary: Cancel Verification
      description: Cancel verification of DNS record.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerificationParameter'
        description: Type of verification to be canceled.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/initiateVerification
  : post:
      operationId: Domains_InitiateVerification
      tags:
      - Domains
      summary: Initiate Verification
      description: Initiate verification of DNS record.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerificationParameter'
        description: Type of verification to be initiated.
        required: true
components:
  schemas:
    VerificationType:
      type: string
      description: Type of verification.
      enum:
      - Domain
      - SPF
      - DKIM
      - DKIM2
      - DMARC
      x-ms-enum:
        name: VerificationType
        modelAsString: true
        values:
        - name: Domain
          value: Domain
          description: Domain
        - name: SPF
          value: SPF
          description: SPF
        - name: DKIM
          value: DKIM
          description: DKIM
        - name: DKIM2
          value: DKIM2
          description: DKIM2
        - name: DMARC
          value: DMARC
          description: DMARC
    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
    DomainPropertiesVerificationStates:
      type: object
      description: List of VerificationStatusRecord
      properties:
        Domain:
          $ref: '#/components/schemas/VerificationStatusRecord'
          description: A class that represents a VerificationStatus record.
        SPF:
          $ref: '#/components/schemas/VerificationStatusRecord'
          description: A class that represents a VerificationStatus record.
        DKIM:
          $ref: '#/components/schemas/VerificationStatusRecord'
          description: A class that represents a VerificationStatus record.
        DKIM2:
          $ref: '#/components/schemas/VerificationStatusRecord'
          description: A class that represents a VerificationStatus record.
        DMARC:
          $ref: '#/components/schemas/VerificationStatusRecord'
          description: A class that represents a VerificationStatus record.
    UpdateDomainProperties:
      type: object
      description: A class that describes the updatable properties of a Domains resource.
      properties:
        userEngagementTracking:
          $ref: '#/components/schemas/UserEngagementTracking'
          description: Describes whether user engagement tracking is enabled or disabled.
    VerificationParameter:
      type: object
      description: Input parameter for verification APIs
      properties:
        verificationType:
          $ref: '#/components/schemas/VerificationType'
          description: Type of verification.
      required:
      - verificationType
    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
    TaggedResource:
      type: object
      description: An ARM resource with that can accept tags
      properties:
        tags:
          type: object
          description: Tags of the service which is a list of key value pairs that describe the resource.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
    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: '#/components/schemas/Resource'
    DomainProperties:
      type: object
      description: A class that describes the properties of a Domains resource.
      properties:
        provisioningState:
          $ref: '#/components/schemas/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: '#/components/schemas/DomainManagement'
          description: Describes how a Domains resource is being managed.
        verificationStates:
          $ref: '#/components/schemas/DomainPropertiesVerificationStates'
          description: List of VerificationStatusRecord
          readOnly: true
        verificationRecords:
          $ref: '#/components/schemas/DomainPropertiesVerificationRecords'
          description: List of DnsRecord
          readOnly: true
        userEngagementTracking:
          $ref: '#/components/schemas/UserEngagementTracking'
          description: Describes whether user engagement tracking is enabled or disabled.
      required:
      - domainManagement
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    DomainPropertiesVerificationRecords:
      type: object
      description: List of DnsRecord
      properties:
        Domain:
          $ref: '#/components/schemas/DnsRecord'
          description: A class that represents a VerificationStatus record.
        SPF:
          $ref: '#/components/schemas/DnsRecord'
          description: A class that represents a VerificationStatus record.
        DKIM:
          $ref: '#/components/schemas/DnsRecord'
          description: A class that represents a VerificationStatus record.
        DKIM2:
          $ref: '#/components/schemas/DnsRecord'
          description: A class that represents a VerificationStatus record.
        DMARC:
          $ref: '#/components/schemas/DnsRecord'
          description: A class that represents a VerificationStatus record.
    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
    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
    UpdateDomainRequestParameters:
      type: object
      description: A class that describes the PATCH request parameters of a Domains resource.
      properties:
        properties:
          $ref: '#/components/schemas/UpdateDomainProperties'
          description: A class that describes the updatable properties of a Domains resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TaggedResource'
    DomainResourceList:
      type: object
      description: Object that includes an array of Domains resource and a possible link for next set.
      properties:
        value:
          type: array
          description: The DomainResource items on this page
          items:
            $ref: '#/components/schemas/DomainResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    VerificationStatusRecord:
      type: object
      description: A class that represents a VerificationStatus record.
      properties:
        status:
          $ref: '#/components/schemas/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
    DomainResource:
      type: object
      description: A class representing a Domains resource.
      properties:
        properties:
          $ref: '#/components/schemas/DomainProperties'
          description: The properties of a Domains resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.