Microsoft Azure Voice Services is a cloud-based platform that allows developers to integrate high-quality speech recognition and natural language processing capabilities into their applications. This service enables users to interact with applications using spoken commands and responses, creating a more seamless and user-friendly experience.
swagger: '2.0'
info:
title: Microsoft Azure Microsoft.VoiceServices
version: 2022-12-01-preview
x-cadl-generated:
- emitter: '@azure-tools/cadl-autorest'
schemes:
- https
host: management.azure.com
produces:
- application/json
consumes:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow.
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
tags:
- name: CommunicationsGateways
- name: Contacts
- name: Operations
- name: TestLines
paths:
/providers/Microsoft.VoiceServices/operations:
get:
tags:
- Operations
operationId: microsoftAzureOperationsList
description: List the operations for the provider
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult
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:
OperationsList:
$ref: ./examples/Operations_List.json
summary: Microsoft Azure Get Providers Microsoft Voiceservices Operations
/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
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/contacts
: get:
tags:
- Contacts
operationId: microsoftAzureContactsListbycommunicationsgateway
description: List Contact resources by 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/ContactListResult'
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:
ListContactsResource:
$ref: ./examples/Contacts_ListByCommunicationsGateway.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Contacts
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/contacts/{contactName}
: get:
tags:
- Contacts
operationId: microsoftAzureContactsGet
description: Get a Contact
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'
- $ref: '#/parameters/Contact.contactName'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Contact'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
GetContactResource:
$ref: ./examples/Contacts_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Contacts Contactname
put:
tags:
- Contacts
operationId: microsoftAzureContactsCreateorupdate
description: Create a Contact
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'
- $ref: '#/parameters/Contact.contactName'
- name: resource
in: body
required: true
description: Resource create parameters.
schema:
$ref: '#/definitions/Contact'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Contact'
'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/Contact'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
CreateContactResource:
$ref: ./examples/Contacts_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 Contacts Contactname
delete:
tags:
- Contacts
operationId: microsoftAzureContactsDelete
description: Delete a Contact
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'
- $ref: '#/parameters/Contact.contactName'
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:
DeleteContactResource:
$ref: ./examples/Contacts_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 Contacts Contactname
patch:
tags:
- Contacts
operationId: microsoftAzureContactsUpdate
description: Update a Contact
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'
- $ref: '#/parameters/Contact.contactName'
- name: properties
in: body
required: true
description: The resource properties to be updated.
schema:
$ref: '#/definitions/ContactUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Contact'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
UpdateContactResource:
$ref: ./examples/Contacts_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Contacts Contactname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/testLines
: get:
tags:
- TestLines
operationId: microsoftAzureTestlinesListbycommunicationsgateway
description: List TestLine resources by 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/TestLineListResult'
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:
ListTestLineResource:
$ref: ./examples/TestLines_ListByCommunicationsGateway.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Testlines
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/testLines/{testLineName}
: get:
tags:
- TestLines
operationId: microsoftAzureTestlinesGet
description: Get a TestLine
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'
- $ref: '#/parameters/TestLine.testLineName'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TestLine'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
GetTestLineResource:
$ref: ./examples/TestLines_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Testlines Testlinename
put:
tags:
- TestLines
operationId: microsoftAzureTestlinesCreateorupdate
description: Create a TestLine
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'
- $ref: '#/parameters/TestLine.testLineName'
- name: resource
in: body
required: true
description: Resource create parameters.
schema:
$ref: '#/definitions/TestLine'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TestLine'
'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/TestLine'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
CreateTestLineResource:
$ref: ./examples/TestLines_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 Testlines Testlinename
delete:
tags:
- TestLines
operationId: microsoftAzureTestlinesDelete
description: Delete a TestLine
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'
- $ref: '#/parameters/TestLine.testLineName'
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:
DeleteTestLineResource:
$ref: ./examples/TestLines_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 Testlines Testlinename
patch:
tags:
- TestLines
operationId: microsoftAzureTestlinesUpdate
description: Update a TestLine
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'
- $ref: '#/parameters/TestLine.testLineName'
- name: properties
in: body
required: true
description: The resource properties to be updated.
schema:
$ref: '#/definitions/TestLineUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TestLine'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
UpdateTestLineResource:
$ref: ./examples/TestLines_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Voiceservices Communicationsgateways Communicationsgatewayname Testlines Testlinename
definitions:
ApiBridgeProperties:
type: object
properties: {}
description: Details of API bridge functionality.
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
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
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
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.
CommunicationsPlatform:
type: string
description: Available platform types.
enum:
- OperatorConnect
- TeamsPhoneMobile
x-ms-enum:
name: CommunicationsPlatform
modelAsString: true
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
Contact:
type: object
properties:
properties:
$ref: '#/definitions/ContactProperties'
description: The resource-specific prope
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoftvoiceservices-openapi-original.yml