Microsoft Azure TeamsCapabilityPlans API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft.VoiceServices.Provisioning Teams…
  version: 2024-02-29-preview
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default
tags:
- name: TeamsCapabilityPlans
paths:
  /accounts/{accountName}:getTeamsCapabilityPlans:
    post:
      operationId: microsoftAzureAccountsGetteamscapabilityplans
      tags:
      - TeamsCapabilityPlans
      summary: Microsoft Azure Get Teams Usages
      description: Get a list of Teams capability plans on the specified account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: accountName
        in: path
        description: Name of the account.
        required: true
        schema:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^([A-Za-z0-9_-]+)$
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Repeatability-Result:
              description: Indicates whether the repeatable request was accepted or 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.'
              schema:
                type: string
                enum:
                - accepted
                - rejected
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamsCapabilityPlans'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Get the list of capability plans available to this account.:
          $ref: ./examples/PostGetAccountTeamsCapabilityPlans.json
components:
  schemas:
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    TeamsCapabilityPlans:
      type: object
      description: The Teams telephone number upload usages for this account.
      properties:
        capabilityPlans:
          type: array
          description: A list of telephone number upload usages.
          items:
            $ref: '#/components/schemas/TeamsCapabilityPlan'
          readOnly: true
          x-ms-identifiers: []
      required:
      - capabilityPlans
    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: '#/components/schemas/Azure.Core.Foundations.Error'
          x-ms-identifiers: []
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    TeamsCapabilityPlan:
      type: object
      description: A teams capability plan for a given usage.
      properties:
        name:
          type: string
          description: The capability plan name.
          readOnly: true
        offerTypes:
          type: array
          description: The offer types available.
          items:
            type: string
          readOnly: true
        usage:
          type: string
          description: The telephone number usage.
          readOnly: true
        mandatoryCapabilities:
          type: array
          description: Mandatory capabilities for telephone numbers.
          items:
            type: string
          readOnly: true
        choosableCapabilities:
          type: array
          description: Choosable capabilities for telephone numbers.
          items:
            type: string
          readOnly: true
        supportsTollFree:
          type: boolean
          description: Boolean indicating if Toll free is supported.
          readOnly: true
      required:
      - name
      - usage
      - supportsTollFree
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId:
      name: Repeatability-Request-ID
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityRequestId
      schema:
        type: string
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent:
      name: Repeatability-First-Sent
      in: header
      description: Specifies the date and time at which the request was first created.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityFirstSent
      schema:
        type: string
        format: date-time
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default: ''
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token