CommunicationsGateway interface

Package:

@azure/arm-voiceservices

A CommunicationsGateway resource

Extends

TrackedResource

Properties

apiBridge	Details of API bridge functionality, if required
autoGeneratedDomainNameLabel	The autogenerated label used as part of the FQDNs for accessing the Communications Gateway NOTE: This property will not be serialized. It can only be populated by the server.
autoGeneratedDomainNameLabelScope	The scope at which the auto-generated domain name can be re-used
codecs	Voice codecs to support
connectivity	How to connect back to the operator network, e.g. MAPS
e911Type	How to handle 911 calls
emergencyDialStrings	A list of dial strings used for emergency calling.
onPremMcpEnabled	Whether an on-premises Mobile Control Point is in use.
platforms	What platforms to support
provisioningState	Resource provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
serviceLocations	The regions in which to deploy the resources needed for Teams Calling
status	The current status of the deployment. NOTE: This property will not be serialized. It can only be populated by the server.
teamsVoicemailPilotNumber	This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiBridge

Details of API bridge functionality, if required

apiBridge?: Record<string, unknown>

Property Value

Record<string, unknown>

autoGeneratedDomainNameLabel

The autogenerated label used as part of the FQDNs for accessing the Communications Gateway NOTE: This property will not be serialized. It can only be populated by the server.

autoGeneratedDomainNameLabel?: string

Property Value

string

autoGeneratedDomainNameLabelScope

The scope at which the auto-generated domain name can be re-used

autoGeneratedDomainNameLabelScope?: string

Property Value

string

codecs

Voice codecs to support

codecs?: string[]

Property Value

string[]

connectivity

How to connect back to the operator network, e.g. MAPS

connectivity?: string

Property Value

string

e911Type

How to handle 911 calls

e911Type?: string

Property Value

string

emergencyDialStrings

A list of dial strings used for emergency calling.

emergencyDialStrings?: string[]

Property Value

string[]

onPremMcpEnabled

Whether an on-premises Mobile Control Point is in use.

onPremMcpEnabled?: boolean

Property Value

boolean

platforms

What platforms to support

platforms?: string[]

Property Value

string[]

provisioningState

Resource provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

serviceLocations

The regions in which to deploy the resources needed for Teams Calling

serviceLocations?: ServiceRegionProperties[]

Property Value

ServiceRegionProperties[]

status

The current status of the deployment. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

teamsVoicemailPilotNumber

This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

teamsVoicemailPilotNumber?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type