Microsoft Azure Number API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Number API
schemes:
- https
tags:
- name: Number
paths:
  /account/{accountName}/numbers:
    get:
      operationId: microsoftAzureAccountListnumbers
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - $ref: '#/parameters/ApiVersionParameter'
      - format: int32
        in: query
        name: maxpagesize
        type: integer
        description: Maximum number of records to include in a single response. Defaults to 200, and must not exceed 500.
      - format: int32
        in: query
        name: skip
        type: integer
        description: An offset into the collection of the first record to be returned.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NumbersList'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get account numbers.:
          $ref: ./examples/GetAccountNumbers.json
      tags:
      - Number
      description: Gets a list of the numbers assigned to the specified account. Response pagination can be controlled with a combination of the maxpagesize and skip parameters. Limit the number of records in a response with the maxpagesize parameter. Specify the starting record using the skip parameter.
      summary: Microsoft Azure Get Account Accountname Numbers
  /account/{accountName}/numbers/{phoneNumber}:
    delete:
      operationId: microsoftAzureNumberDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - in: path
        name: phoneNumber
        pattern: ^\+[1-9]\d+$
        minLength: 3
        maxLength: 16
        required: true
        type: string
        description: Phone number in E.164 format.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: No Content
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete a number.:
          $ref: ./examples/DeleteNumber.json
      tags:
      - Number
      description: Removes the specified number from the specified account.
      summary: Microsoft Azure Delete Account Accountname Numbers Phonenumber
    get:
      operationId: microsoftAzureNumberGet
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - in: path
        name: phoneNumber
        pattern: ^\+[1-9]\d+$
        minLength: 3
        maxLength: 16
        required: true
        type: string
        description: Phone number in E.164 format.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NumberResponse'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get a number.:
          $ref: ./examples/GetNumber.json
      tags:
      - Number
      description: Gets the details of a number assigned to an account, including the services for which the number is enabled.
      summary: Microsoft Azure Get Account Accountname Numbers Phonenumber
    put:
      operationId: microsoftAzureNumberCreateorreplace
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: accountName
        pattern: ^([A-Za-z0-9_-]+)$
        minLength: 1
        maxLength: 100
        required: true
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
      - in: path
        name: phoneNumber
        pattern: ^\+[1-9]\d+$
        minLength: 3
        maxLength: 16
        required: true
        type: string
        description: Phone number in E.164 format.
      - $ref: '#/parameters/ApiVersionParameter'
      - in: header
        name: If-Match
        type: string
        description: Makes a request conditional on a matching etag.
      - in: header
        name: If-None-Match
        type: string
        description: Makes a request conditional on a non-matching etag.
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/NumberDetails'
        description: New details of the number to create or replace.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NumberResponse'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/NumberResponse'
        default:
          description: An error response object.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Put a number.:
          $ref: ./examples/PutNumber.json
      tags:
      - Number
      description: Creates or replaces the specified number in the specified account. In the body of the request, include the service for which this number is enabled. If the service is not specified, Operator Connect service is enabled by default. Optionally, include additional configuration for the number.
      summary: Microsoft Azure Put Account Accountname Numbers Phonenumber
  /accounts/{accountName}/numbers:
    get:
      operationId: microsoftAzureAccountsListnumbers
      tags:
      - Number
      summary: Microsoft Azure Get Numbers
      description: Get a list of Numbers on the specified account.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/parameters/FilterQueryParameter'
      - $ref: '#/parameters/RecordCountQueryParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedNumberResource'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
            x-ms-record-count:
              type: integer
              format: int32
              description: The total number of records available for this request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get list of Numbers on an Account.:
          $ref: ./examples/ListAccountNumbers.json
      x-ms-pageable:
        nextLinkName: nextLink
  /accounts/{accountName}/numbers/{telephoneNumber}:
    get:
      operationId: microsoftAzureAccountsGetnumber
      tags:
      - Number
      summary: Microsoft Azure Get Number
      description: Get details of a specific Number using its telephone number.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
      - name: telephoneNumber
        in: path
        description: Telephone number in E.164 format.
        required: true
        type: string
        minLength: 1
        maxLength: 16
        pattern: ^\+[1-9]\d+$
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifNoneMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifModifiedSince'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/NumberResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get a Number from an Account.:
          $ref: ./examples/GetAccountNumber.json
    put:
      operationId: microsoftAzureAccountsCreateorreplacenumber
      tags:
      - Number
      summary: Microsoft Azure Create Or Replace Number
      description: Create or replace the details of a Number.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
      - name: telephoneNumber
        in: path
        description: Telephone number in E.164 format.
        required: true
        type: string
        minLength: 1
        maxLength: 16
        pattern: ^\+[1-9]\d+$
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifNoneMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifModifiedSince'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      - name: resource
        in: body
        description: The resource instance.
        required: true
        schema:
          $ref: '#/definitions/NumberResource'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/NumberResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/NumberResource'
          headers:
            ETag:
              type: string
              description: The entity tag for the response.
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Create or replace a Number.:
          $ref: ./examples/PutAccountNumber.json
    delete:
      operationId: microsoftAzureAccountsDeletenumber
      tags:
      - Number
      summary: Microsoft Azure Delete Number
      description: Delete a specific Number using its telephone number.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
      - name: telephoneNumber
        in: path
        description: Telephone number in E.164 format.
        required: true
        type: string
        minLength: 1
        maxLength: 16
        pattern: ^\+[1-9]\d+$
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifNoneMatch'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifUnmodifiedSince'
      - $ref: '#/parameters/Azure.Core.ConditionalRequestHeaders.ifModifiedSince'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Delete Number from Account.:
          $ref: ./examples/DeleteAccountNumber.json
definitions:
  ErrorDetail:
    title: The code and message for an error.
    type: object
    properties:
      code:
        description: A machine readable error code.
        type: string
      message:
        description: A human readable representation of the error.
        type: string
      details:
        description: An array of details about specific errors that led to this error.
        type: array
        items:
          $ref: '#/definitions/ErrorDetail'
      innererror:
        description: An object containing more specific information about the error.
        $ref: '#/definitions/InnerError'
      additionalProperties:
        description: Additional properties that can be provided about the error.
    required:
    - code
    - message
  TeamsDirectRoutingNumberDetails:
    type: object
    description: Details for the Teams Direct Routing service on this Number.
    properties:
      enabled:
        type: boolean
        description: Boolean indicating if the service is enabled on this Number.
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - enabled
  TeamsPhoneMobileNumberDetails:
    type: object
    description: Details for the Teams Phone Mobile service on this Number.
    properties:
      enabled:
        type: boolean
        description: Boolean indicating if the service is enabled on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      assignmentStatus:
        $ref: '#/definitions/TelephoneNumberAssignmentStatus'
        description: The assignment status of this Number.
        x-ms-mutability:
        - read
        - update
        - create
      configuration:
        $ref: '#/definitions/TeamsPhoneMobileNumberConfig'
        description: The configuration for Teams Phone Mobile on this number.
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - enabled
  TeamsOperatorConnectNumberDetails:
    type: object
    description: Details for the Teams Operator Connect service on this Number.
    properties:
      enabled:
        type: boolean
        description: Boolean indicating if the service is enabled on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      assignmentStatus:
        $ref: '#/definitions/TelephoneNumberAssignmentStatus'
        description: The assignment status of this Number.
        x-ms-mutability:
        - read
        - update
        - create
      configuration:
        $ref: '#/definitions/TeamsOperatorConnectNumberConfig'
        description: The configuration for Teams Operator Connect on this number.
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - enabled
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  NumberConfiguration:
    additionalProperties: false
    properties:
      customSipHeader:
        pattern: ^([A-Za-z0-9_-])+$
        minLength: 1
        maxLength: 100
        type: string
        description: Contents of the custom SIP header to use with this number. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length. The name of the custom header is set as part of deploying Azure Communications Gateway.
    type: object
    description: Configuration for this number.
  PagedNumberResource:
    type: object
    description: Paged collection of NumberResource items
    properties:
      value:
        type: array
        description: The NumberResource items on this page
        items:
          $ref: '#/definitions/NumberResource'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  NumberResource:
    type: object
    description: The configuration for a telephone number provisioned in Azure Communications Gateway.
    properties:
      serviceProvisioningStatus:
        $ref: '#/definitions/ServiceProvisioningStatus'
        description: The status of the provisioning action associated with this resource.
        readOnly: true
      serviceProvisioningErrors:
        type: array
        description: Any errors pertaining to the provisioning of this resource.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        readOnly: true
        x-ms-identifiers: []
      telephoneNumber:
        type: string
        description: Telephone number in E.164 format.
        minLength: 1
        maxLength: 16
        pattern: ^\+[1-9]\d+$
        x-ms-mutability:
        - read
        - update
        - create
      accountName:
        type: string
        description: Name of the account. Can only contain letters, numbers, underscores and dashes, and is case-sensitive. Can be up to 100 characters in length.
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-]+)$
        x-ms-mutability:
        - read
        - update
        - create
      serviceDetails:
        $ref: '#/definitions/NumberServiceDetails'
        description: Configuration of the individual backend services for this number.
        x-ms-mutability:
        - read
        - update
        - create
      configuration:
        $ref: '#/definitions/NumberConfiguration_2'
        description: Configuration for this number.
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - telephoneNumber
    - accountName
    - serviceDetails
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  NumberServices:
    additionalProperties: false
    properties:
      teamsDrEnabled:
        type: boolean
        description: Enables/disables Microsoft Teams Direct Routing for the number.
      teamsOcEnabled:
        type: boolean
        description: Enables/disables Operator Connect for the number.
      zoomEnabled:
        type: boolean
        description: Enables/disables Zoom for the number.
    required:
    - teamsDrEnabled
    - teamsOcEnabled
    - zoomEnabled
    type: object
    description: Communications services enabled for this number.
  NumberResponse:
    additionalProperties: false
    properties:
      etag:
        type: string
        description: ETag for use with If-Match headers for optimistic concurrency.
      accountName:
        minLength: 1
        type: string
        description: Account name which owns this number.
      phoneNumber:
        minLength: 1
        type: string
        description: The phone number corresponding to this entry.
      details:
        $ref: '#/definitions/NumberDetails'
    required:
    - accountName
    - details
    - phoneNumber
    type: object
    description: Details of the number as returned on a GET request.
  NumberServiceDetails:
    type: object
    description: Configuration of backend services for a telephone number.
    properties:
      teamsOperatorConnect:
        $ref: '#/definitions/TeamsOperatorConnectNumberDetails'
        description: Details for the Teams Operator Connect service on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      teamsDirectRouting:
        $ref: '#/definitions/TeamsDirectRoutingNumberDetails'
        description: Details for the Teams Direct Routing service on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      teamsPhoneMobile:
        $ref: '#/definitions/TeamsPhoneMobileNumberDetails'
        description: Details for the Teams Phone Mobile service on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      zoomPhoneCloudPeering:
        $ref: '#/definitions/ZoomPhoneCloudPeeringNumberDetails'
        description: Details for the Zoom Phone Cloud Peering service on this Number.
        x-ms-mutability:
        - read
        - update
        - create
      azureOperatorCallProtection:
        $ref: '#/definitions/AzureOperatorCallProtectionNumberDetails'
        description: Details for the Azure Operator Call Protection service on this Number.
        x-ms-mutability:
        - read
        - update
        - create
  NumberConfiguration_2:
    type: object
    description: Configuration for this number.
    properties:
      customSipHeader:
        type: string
        description: Contents of the custom SIP header to use with this number. Can only contain letters, numbers, underscores and dashes. Can be up to 100 characters in length. The name of the custom header is set as part of the provisioning platform configuration on Azure Communications Gateway.
        minLength: 1
        maxLength: 100
        pattern: ^([A-Za-z0-9_-])+$
        x-ms-mutability:
        - read
        - update
        - create
  NumberDetails:
    additionalProperties: false
    properties:
      configuration:
        $ref: '#/definitions/NumberConfiguration'
      services:
        $ref: '#/definitions/NumberServices'
    required:
    - services
    type: object
    description: Details of the number.
  TelephoneNumberAssignmentStatus:
    type: string
    description: Indicates whether a number is assigned to a user.
    enum:
    - assigned
    - unassigned
    x-ms-enum:
      name: TelephoneNumberAssignmentStatus
      modelAsString: true
      values:
      - name: assigned
        value: assigned
        description: The telephone number is assigned to a user.
      - name: unassigned
        value: unassigned
        description: The telephone number is not assigned to a user.
  TeamsOperatorConnectNumberConfig:
    type: object
    description: Telephone number configuration for Teams Operator Connect telephone numbers.
    properties:
      usage:
        type: string
        description: The usage for this telephone number.
        x-ms-mutability:
        - read
        - update
        - create
      choosableCapabilities:
        type: array
        description: The choosable capabilities for this telephone number.
        items:
          type: string
        x-ms-mutability:
        - read
        - update
        - create
      acquiredCapabilities:
        type: array
        description: The acquired capabilities for this telephone number.
        items:
          type: string
        readOnly: true
      availableCapabilities:
        type: array
        description: The available capabilities for this telephone number.
        items:
          type: string
        readOnly: true
      additionalUsages:
        type: array
        description: The additional usages for this telephone number.
        items:
          type: string
        x-ms-mutability:
        - read
        - update
        - create
      civicAddressId:
        type: string
        description: The ID of the civic address to be used as the emergency address for this telephone number.
        x-ms-mutability:
        - read
        - update
        - create
      locationId:
        type: string
        description: The ID of the location to be used as the emergency address for this telephone number.
        x-ms-mutability:
        - read
        - update
        - create
      allowTenantAddressUpdate:
        type: boolean
        description: If the enterprise is allowed to update the address for this telephone number.
        default: false
        x-ms-mutability:
        - read
        - update
        - create
      displayedCountryCode:
        type: string
        description: The country code to be displayed with this telephone number
        x-ms-mutability:
        - read
        - update
        - create
    required:
    - usage
    - choosableCapabilities
  TeamsPhoneMobileNumberConfig:
    type: object
    description: Telephone number configuration for Teams Phone Mobile telephone numbers.
    properties:
      usage:
        type: string
        description: The usage for this telephone number.
        x-ms-mutability:
        - read
        - update
        - create
      choosableCapabilities:
        type: array
        description: The choosable capabilities for this telephone number.
        items:
          type: string
        x-ms-mutability:
        - read
        - update
        - create
      acquiredCapabilities:
        type: array
        description: The acquired capabilities for this telephone number.
        items:
          type: string
        readOnly: true
      availableCapabilities:
        type: array
        description: The available capabilities for this telephone number.
        items:
          type: string
        readOnly: true
      additionalUsages:
        type: array
        description: The additional usages for this telephone number.
        items:
          type: string
        x-ms-mutability:
        - read
        - update
        - create
      civicAddressId:
        type: string
        description: The ID of the civic address to be used as the emergency address for this telephone number.
        x-ms-mutability:
        - read
        - update
        - create
      locationId:
        type: string
        des

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-number-api-openapi.yml