communications_gateways

Creates, updates, deletes, gets or lists a communications_gateways resource.

Overview

Name	communications_gateways
Type	Resource
Id	azure_extras.voice_services.communications_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiBridge	object	Details of API bridge functionality, if required.
autoGeneratedDomainNameLabel	string	The autogenerated label used as part of the FQDNs for accessing the Communications Gateway.
autoGeneratedDomainNameLabelScope	string	The scope at which the auto-generated domain name can be re-used. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".
codecs	array	Voice codecs to support.
connectivity	string	How to connect back to the operator network, e.g. MAPS. "PublicAddress"
e911Type	string	How to handle 911 calls. Known values are: "Standard" and "DirectToEsrp".
emergencyDialStrings	array	A list of dial strings used for emergency calling.
location	string	The geo-location where the resource lives. Required.
onPremMcpEnabled	boolean	Whether an on-premises Mobile Control Point is in use.
platforms	array	What platforms to support.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
serviceLocations	array	The regions in which to deploy the resources needed for Teams Calling.
status	string	The current status of the deployment. Known values are: "ChangePending" and "Complete".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
teamsVoicemailPilotNumber	string	This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiBridge	object	Details of API bridge functionality, if required.
autoGeneratedDomainNameLabel	string	The autogenerated label used as part of the FQDNs for accessing the Communications Gateway.
autoGeneratedDomainNameLabelScope	string	The scope at which the auto-generated domain name can be re-used. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".
codecs	array	Voice codecs to support.
connectivity	string	How to connect back to the operator network, e.g. MAPS. "PublicAddress"
e911Type	string	How to handle 911 calls. Known values are: "Standard" and "DirectToEsrp".
emergencyDialStrings	array	A list of dial strings used for emergency calling.
location	string	The geo-location where the resource lives. Required.
onPremMcpEnabled	boolean	Whether an on-premises Mobile Control Point is in use.
platforms	array	What platforms to support.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
serviceLocations	array	The regions in which to deploy the resources needed for Teams Calling.
status	string	The current status of the deployment. Known values are: "ChangePending" and "Complete".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
teamsVoicemailPilotNumber	string	This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiBridge	object	Details of API bridge functionality, if required.
autoGeneratedDomainNameLabel	string	The autogenerated label used as part of the FQDNs for accessing the Communications Gateway.
autoGeneratedDomainNameLabelScope	string	The scope at which the auto-generated domain name can be re-used. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".
codecs	array	Voice codecs to support.
connectivity	string	How to connect back to the operator network, e.g. MAPS. "PublicAddress"
e911Type	string	How to handle 911 calls. Known values are: "Standard" and "DirectToEsrp".
emergencyDialStrings	array	A list of dial strings used for emergency calling.
location	string	The geo-location where the resource lives. Required.
onPremMcpEnabled	boolean	Whether an on-premises Mobile Control Point is in use.
platforms	array	What platforms to support.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
serviceLocations	array	The regions in which to deploy the resources needed for Teams Calling.
status	string	The current status of the deployment. Known values are: "ChangePending" and "Complete".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
teamsVoicemailPilotNumber	string	This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, communications_gateway_name, subscription_id		Get a CommunicationsGateway.
list_by_resource_group	select	resource_group_name, subscription_id		List CommunicationsGateway resources by resource group.
list_by_subscription	select	subscription_id		List CommunicationsGateway resources by subscription ID.
create_or_update	insert	resource_group_name, communications_gateway_name, subscription_id, location		Create a CommunicationsGateway.
update	update	resource_group_name, communications_gateway_name, subscription_id		Update a CommunicationsGateway.
create_or_update	replace	resource_group_name, communications_gateway_name, subscription_id, location		Create a CommunicationsGateway.
delete	delete	resource_group_name, communications_gateway_name, subscription_id		Delete a CommunicationsGateway.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
communications_gateway_name	string	Unique identifier for this deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a CommunicationsGateway.

SELECT
id,
name,
apiBridge,
autoGeneratedDomainNameLabel,
autoGeneratedDomainNameLabelScope,
codecs,
connectivity,
e911Type,
emergencyDialStrings,
location,
onPremMcpEnabled,
platforms,
provisioningState,
serviceLocations,
status,
systemData,
tags,
teamsVoicemailPilotNumber,
type
FROM azure_extras.voice_services.communications_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communications_gateway_name = '{{ communications_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List CommunicationsGateway resources by resource group.

SELECT
id,
name,
apiBridge,
autoGeneratedDomainNameLabel,
autoGeneratedDomainNameLabelScope,
codecs,
connectivity,
e911Type,
emergencyDialStrings,
location,
onPremMcpEnabled,
platforms,
provisioningState,
serviceLocations,
status,
systemData,
tags,
teamsVoicemailPilotNumber,
type
FROM azure_extras.voice_services.communications_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List CommunicationsGateway resources by subscription ID.

SELECT
id,
name,
apiBridge,
autoGeneratedDomainNameLabel,
autoGeneratedDomainNameLabelScope,
codecs,
connectivity,
e911Type,
emergencyDialStrings,
location,
onPremMcpEnabled,
platforms,
provisioningState,
serviceLocations,
status,
systemData,
tags,
teamsVoicemailPilotNumber,
type
FROM azure_extras.voice_services.communications_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a CommunicationsGateway.

INSERT INTO azure_extras.voice_services.communications_gateways (
tags,
location,
properties,
resource_group_name,
communications_gateway_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ communications_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: communications_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the communications_gateways resource.
  - name: communications_gateway_name
    value: "{{ communications_gateway_name }}"
    description: Required parameter for the communications_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the communications_gateways resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      serviceLocations:
        - name: "{{ name }}"
          primaryRegionProperties:
            operatorAddresses:
              - "{{ operatorAddresses }}"
            esrpAddresses:
              - "{{ esrpAddresses }}"
            allowedSignalingSourceAddressPrefixes:
              - "{{ allowedSignalingSourceAddressPrefixes }}"
            allowedMediaSourceAddressPrefixes:
              - "{{ allowedMediaSourceAddressPrefixes }}"
      connectivity: "{{ connectivity }}"
      codecs:
        - "{{ codecs }}"
      e911Type: "{{ e911Type }}"
      platforms:
        - "{{ platforms }}"
      apiBridge: "{{ apiBridge }}"
      autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"
      teamsVoicemailPilotNumber: "{{ teamsVoicemailPilotNumber }}"
      onPremMcpEnabled: {{ onPremMcpEnabled }}
      emergencyDialStrings:
        - "{{ emergencyDialStrings }}"

UPDATE examples

update

Update a CommunicationsGateway.

UPDATE azure_extras.voice_services.communications_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a CommunicationsGateway.

REPLACE azure_extras.voice_services.communications_gateways
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a CommunicationsGateway.

DELETE FROM azure_extras.voice_services.communications_gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND communications_gateway_name = '{{ communications_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;