Microsoft Azure Communication Services Email Services API

openapi: 3.2.0
info:
  title: Azure Communication Services Management Email Services 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: EmailServices
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/emailServices:
    get:
      operationId: EmailServices_ListBySubscription
      tags:
      - EmailServices
      summary: List By Subscription
      description: Handles requests to list all resources in a subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailServiceResourceList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/listVerifiedExchangeOnlineDomains:
    post:
      operationId: EmailServices_ListVerifiedExchangeOnlineDomains
      tags:
      - EmailServices
      summary: List Verified Domains From Exchange Online
      description: Get a list of domains that are fully verified in Exchange Online.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifiedExchangeOnlineDomainList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices:
    get:
      operationId: EmailServices_ListByResourceGroup
      tags:
      - EmailServices
      summary: List By Resource Group
      description: Handles requests to list all resources in a resource group.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailServiceResourceList'
        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}
  : get:
      operationId: EmailServices_Get
      tags:
      - EmailServices
      summary: Get
      description: Get the EmailService 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-]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailServiceResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: EmailServices_CreateOrUpdate
      tags:
      - EmailServices
      summary: Create Or Update
      description: Create a new EmailService or update an existing EmailService.
      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: Resource 'EmailServiceResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailServiceResource'
        '201':
          description: Resource 'EmailServiceResource' 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/EmailServiceResource'
        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/EmailServiceResource'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailServiceResource'
        description: Parameters for the create or update operation
        required: true
    patch:
      operationId: EmailServices_Update
      tags:
      - EmailServices
      summary: Update
      description: Operation to update an existing EmailService.
      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: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailServiceResource'
        '201':
          description: Resource 'EmailServiceResource' 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/EmailServiceResource'
        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/EmailServiceResource'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailServiceResourceUpdate'
        description: Parameters for the update operation
        required: true
    delete:
      operationId: EmailServices_Delete
      tags:
      - EmailServices
      summary: Delete
      description: Operation to delete a EmailService.
      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: 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
components:
  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
  schemas:
    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.
    VerifiedExchangeOnlineDomainList:
      type: array
      description: List of FQDNs of verified domains in Exchange Online.
      items:
        type: string
    EmailServiceResourceList:
      type: object
      description: Object that includes an array of EmailServices and a possible link for next set.
      properties:
        value:
          type: array
          description: The EmailServiceResource items on this page
          items:
            $ref: '#/components/schemas/EmailServiceResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    EmailServiceProperties:
      type: object
      description: A class that describes the properties of the EmailService.
      properties:
        provisioningState:
          $ref: '#/components/schemas/EmailServices_ProvisioningState'
          description: Provisioning state of the resource.
          readOnly: true
        dataLocation:
          type: string
          description: The location where the email service stores its data at rest.
          x-ms-mutability:
          - read
          - create
      required:
      - dataLocation
    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'
    EmailServiceResource:
      type: object
      description: A class representing an EmailService resource.
      properties:
        properties:
          $ref: '#/components/schemas/EmailServiceProperties'
          description: The properties of the service.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    EmailServices_ProvisioningState:
      type: string
      description: Provisioning state of the resource.
      enum:
      - Unknown
      - Succeeded
      - Failed
      - Canceled
      - Running
      - Creating
      - Updating
      - Deleting
      - Moving
      x-ms-enum:
        name: EmailServices_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
    EmailServiceResourceUpdate:
      type: object
      description: A class representing update parameters for EmailService resource.
      allOf:
      - $ref: '#/components/schemas/TaggedResource'
  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.