swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CommunicationsGateways API
schemes:
- https
tags:
- name: CommunicationsGateways
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.VoiceServices/communicationsGateways:
    get:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysListbysubscription
      description: List CommunicationsGateway resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/CommunicationsGatewayListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListCommunicationsGatewayResourceSub:
          $ref: ./examples/CommunicationsGateways_ListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Voiceservices Communicationsgateways
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways
  : get:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysListbyresourcegroup
      description: List CommunicationsGateway resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/CommunicationsGatewayListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListCommunicationsGatewayResource:
          $ref: ./examples/CommunicationsGateways_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}
  : get:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysGet
      description: Get a CommunicationsGateway
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CommunicationsGateway.communicationsGatewayName'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/CommunicationsGateway'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        GetCommunicationsGatewayResource:
          $ref: ./examples/CommunicationsGateways_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname
    put:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysCreateorupdate
      description: Create a CommunicationsGateway
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CommunicationsGateway.communicationsGatewayName'
      - name: resource
        in: body
        required: true
        description: Resource create parameters.
        schema:
          $ref: '#/definitions/CommunicationsGateway'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/CommunicationsGateway'
        '201':
          description: ARM create operation completed successfully.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              type: integer
              format: int32
          schema:
            $ref: '#/definitions/CommunicationsGateway'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CreateCommunicationsGatewayResource:
          $ref: ./examples/CommunicationsGateways_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname
    delete:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysDelete
      description: Delete a CommunicationsGateway
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CommunicationsGateway.communicationsGatewayName'
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              type: integer
              format: int32
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeleteCommunicationsGatewayResource:
          $ref: ./examples/CommunicationsGateways_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname
    patch:
      tags:
      - CommunicationsGateways
      operationId: microsoftAzureCommunicationsgatewaysUpdate
      description: Update a CommunicationsGateway
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CommunicationsGateway.communicationsGatewayName'
      - name: properties
        in: body
        required: true
        description: The resource properties to be updated.
        schema:
          $ref: '#/definitions/CommunicationsGatewayUpdate'
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/CommunicationsGateway'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        UpdateCommunicationsGatewayResource:
          $ref: ./examples/CommunicationsGateways_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname
definitions:
  ApiBridgeProperties:
    type: object
    properties: {}
    description: Details of API bridge functionality.
  CommunicationsPlatform:
    type: string
    description: Available platform types.
    enum:
    - OperatorConnect
    - TeamsPhoneMobile
    x-ms-enum:
      name: CommunicationsPlatform
      modelAsString: true
  TeamsCodecs:
    type: string
    description: The voice codecs expected for communication with Teams.
    enum:
    - PCMA
    - PCMU
    - G722
    - G722_2
    - SILK_8
    - SILK_16
    x-ms-enum:
      name: TeamsCodecs
      modelAsString: true
  CommunicationsGatewayListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/CommunicationsGateway'
        x-cadl-name: CommunicationsGateway[]
        description: The CommunicationsGateway items on this page
      nextLink:
        type: string
        description: The link to the next page of items
        x-cadl-name: Rest.ResourceLocation<CommunicationsGateway>
    description: The response of a CommunicationsGateway list operation.
    required:
    - value
  CommunicationsGateway:
    type: object
    properties:
      properties:
        $ref: '#/definitions/CommunicationsGatewayProperties'
        description: The resource-specific properties for this resource.
        x-ms-mutability:
        - read
        - create
        x-ms-client-flatten: true
    description: A CommunicationsGateway resource
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  ProvisioningState:
    type: string
    description: Provisioning state of the resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  ServiceRegionProperties:
    type: object
    properties:
      name:
        type: string
        description: The name of the region in which the resources needed for Teams Calling will be deployed.
        x-ms-mutability:
        - read
        - create
      primaryRegionProperties:
        $ref: '#/definitions/PrimaryRegionProperties'
        description: The configuration used in this region as primary, and other regions as backup.
        x-ms-mutability:
        - read
        - update
        - create
    description: The service region configuration needed for Teams Callings.
    required:
    - name
    - primaryRegionProperties
  Connectivity:
    type: string
    description: How this deployment connects back to the operator network
    enum:
    - PublicAddress
    x-ms-enum:
      name: Connectivity
      modelAsString: true
      values:
      - name: PublicAddress
        value: PublicAddress
        description: This deployment connects to the operator network using a Public IP address, e.g. when using MAPS
  Status:
    type: string
    description: The status of the current CommunicationsGateway resource.
    enum:
    - ChangePending
    - Complete
    x-ms-enum:
      name: Status
      modelAsString: false
      values:
      - name: ChangePending
        value: ChangePending
        description: The resource has been created or updated, but the CommunicationsGateway service has not yet been updated to reflect the changes.
      - name: Complete
        value: Complete
        description: The CommunicationsGateway service is up and running with the parameters specified in the resource.
  CommunicationsGatewayUpdate:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-cadl-name: Record<string>
        description: Resource tags.
    description: The type used for update operations of the CommunicationsGateway.
  PrimaryRegionProperties:
    type: object
    properties:
      operatorAddresses:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: IP address to use to contact the operator network from this region
        x-ms-mutability:
        - read
        - update
        - create
      esrpAddresses:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: IP address to use to contact the ESRP from this region
        x-ms-mutability:
        - read
        - update
        - create
    description: The configuration used in this region as primary, and other regions as backup.
    required:
    - operatorAddresses
  CommunicationsGatewayProperties:
    type: object
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Resource provisioning state.
        readOnly: true
      status:
        $ref: '#/definitions/Status'
        description: The current status of the deployment.
        readOnly: true
      serviceLocations:
        type: array
        items:
          $ref: '#/definitions/ServiceRegionProperties'
        x-ms-identifiers:
        - name
        x-cadl-name: ServiceRegionProperties[]
        description: The regions in which to deploy the resources needed for Teams Calling
        x-ms-mutability:
        - read
        - update
        - create
      connectivity:
        $ref: '#/definitions/Connectivity'
        description: How to connect back to the operator network, e.g. MAPS
        x-ms-mutability:
        - read
        - create
      codecs:
        type: array
        items:
          $ref: '#/definitions/TeamsCodecs'
        x-cadl-name: TeamsCodecs[]
        description: Voice codecs to support
        x-ms-mutability:
        - read
        - update
        - create
      e911Type:
        $ref: '#/definitions/E911Type'
        description: How to handle 911 calls
        x-ms-mutability:
        - read
        - update
        - create
      platforms:
        type: array
        items:
          $ref: '#/definitions/CommunicationsPlatform'
        x-cadl-name: CommunicationsPlatform[]
        description: What platforms to support
        x-ms-mutability:
        - read
        - update
        - create
      apiBridge:
        $ref: '#/definitions/ApiBridgeProperties'
        description: Details of API bridge functionality, if required
        x-ms-mutability:
        - read
        - update
        - create
    description: Details of the CommunicationsGateway resource.
    required:
    - serviceLocations
    - connectivity
    - codecs
    - e911Type
    - platforms
  E911Type:
    type: string
    description: The method for terminating emergency calls to the PSTN.
    enum:
    - Standard
    - DirectToEsrp
    x-ms-enum:
      name: E911Type
      modelAsString: true
      values:
      - name: Standard
        value: Standard
        description: Emergency calls are not handled different from other calls
      - name: DirectToEsrp
        value: DirectToEsrp
        description: Emergency calls are routed directly to the ESRP
parameters:
  CommunicationsGateway.communicationsGatewayName:
    name: communicationsGatewayName
    in: path
    required: true
    description: Unique identifier for this deployment
    pattern: ^[a-zA-Z0-9-]{3,24}$
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'