Microsoft Azure Communication Services Sender Usernames API

openapi: 3.2.0
info:
  title: Azure Communication Services Management Sender Usernames 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: SenderUsernames
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames
  : get:
      operationId: SenderUsernames_ListByDomains
      tags:
      - SenderUsernames
      summary: ListBy_Domains
      description: List all valid sender usernames for 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: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderUsernameResourceCollection'
        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}/senderUsernames/{senderUsername}
  : get:
      operationId: SenderUsernames_Get
      tags:
      - SenderUsernames
      summary: Get
      description: Get a valid sender username for 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
      - name: senderUsername
        in: path
        description: The valid sender Username.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderUsernameResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: SenderUsernames_CreateOrUpdate
      tags:
      - SenderUsernames
      summary: Create Or Update
      description: Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername 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
      - name: senderUsername
        in: path
        description: The valid sender Username.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Resource 'SenderUsernameResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderUsernameResource'
        '201':
          description: Resource 'SenderUsernameResource' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderUsernameResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SenderUsernameResource'
        description: Parameters for the create or update operation
        required: true
    delete:
      operationId: SenderUsernames_Delete
      tags:
      - SenderUsernames
      summary: Delete
      description: Operation to delete a SenderUsernames 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
      - name: senderUsername
        in: path
        description: The valid sender Username.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SenderUsernameProperties:
      type: object
      description: A class that describes the properties of a SenderUsername resource.
      properties:
        dataLocation:
          type: string
          description: The location where the SenderUsername resource data is stored at rest.
          readOnly: true
        username:
          type: string
          description: A sender senderUsername to be used when sending emails.
        displayName:
          type: string
          description: The display name for the senderUsername.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: Provisioning state of the resource. Unknown is the default state for Communication Services.
          readOnly: true
      required:
      - username
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    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.
    SenderUsernameResourceCollection:
      type: object
      description: A class representing a Domains SenderUsernames collection.
      properties:
        value:
          type: array
          description: The SenderUsernameResource items on this page
          items:
            $ref: '#/components/schemas/SenderUsernameResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SenderUsernameResource:
      type: object
      description: A class representing a SenderUsername resource.
      properties:
        properties:
          $ref: '#/components/schemas/SenderUsernameProperties'
          description: The properties of a SenderUsername resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    ProvisioningState:
      type: string
      description: Provisioning state of the resource. Unknown is the default state for Communication Services.
      enum:
      - Unknown
      - Succeeded
      - Failed
      - Canceled
      - Running
      - Creating
      - Updating
      - Deleting
      - Moving
      x-ms-enum:
        name: 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
  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.