communications_gateways

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

Overview

Name	communications_gateways
Type	Resource
Id	azure.voice_services.communications_gateways

Fields

vw_communications_gateways

Name	Datatype	Description
allocated_media_address_prefixes	text	field from the properties object
allocated_signaling_address_prefixes	text	field from the properties object
api_bridge	text	field from the properties object
auto_generated_domain_name_label	text	field from the properties object
auto_generated_domain_name_label_scope	text	field from the properties object
codecs	text	field from the properties object
communicationsGatewayName	text	field from the properties object
connectivity	text	field from the properties object
custom_sip_headers	text	field from the properties object
dns_delegations	text	field from the properties object
e911_type	text	field from the properties object
emergency_dial_strings	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
integrated_mcp_enabled	text	field from the properties object
location	text	The geo-location where the resource lives
on_prem_mcp_enabled	text	field from the properties object
platforms	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
service_locations	text	field from the properties object
sku	text	The resource model definition representing SKU
status	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
teams_voicemail_pilot_number	text	field from the properties object

communications_gateways

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Details of the CommunicationsGateway resource.
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	communicationsGatewayName, resourceGroupName, subscriptionId	Get a CommunicationsGateway
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List CommunicationsGateway resources by resource group
list_by_subscription	SELECT	subscriptionId	List CommunicationsGateway resources by subscription ID
create_or_update	INSERT	communicationsGatewayName, resourceGroupName, subscriptionId	Create a CommunicationsGateway
delete	DELETE	communicationsGatewayName, resourceGroupName, subscriptionId	Delete a CommunicationsGateway
update	UPDATE	communicationsGatewayName, resourceGroupName, subscriptionId	Update a CommunicationsGateway

SELECT examples

List CommunicationsGateway resources by subscription ID

vw_communications_gateways

SELECT
allocated_media_address_prefixes,
allocated_signaling_address_prefixes,
api_bridge,
auto_generated_domain_name_label,
auto_generated_domain_name_label_scope,
codecs,
communicationsGatewayName,
connectivity,
custom_sip_headers,
dns_delegations,
e911_type,
emergency_dial_strings,
identity,
integrated_mcp_enabled,
location,
on_prem_mcp_enabled,
platforms,
provisioning_state,
resourceGroupName,
service_locations,
sku,
status,
subscriptionId,
tags,
teams_voicemail_pilot_number
FROM azure.voice_services.vw_communications_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

communications_gateways

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.voice_services.communications_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new communications_gateways resource.

All Properties

/*+ create */
INSERT INTO azure.voice_services.communications_gateways (
communicationsGatewayName,
resourceGroupName,
subscriptionId,
properties,
identity,
sku,
tags,
location
)
SELECT 
'{{ communicationsGatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: status
          value: []
        - name: serviceLocations
          value:
            - - name: name
                value: string
              - name: primaryRegionProperties
                value:
                  - name: operatorAddresses
                    value:
                      - string
                  - name: esrpAddresses
                    value:
                      - string
                  - name: allowedSignalingSourceAddressPrefixes
                    value:
                      - string
                  - name: allowedMediaSourceAddressPrefixes
                    value:
                      - string
        - name: connectivity
          value: []
        - name: codecs
          value:
            - []
        - name: e911Type
          value: []
        - name: platforms
          value:
            - []
        - name: apiBridge
          value:
            - name: configureApiBridge
              value: []
            - name: endpointFqdns
              value:
                - string
            - name: allowedAddressPrefixes
              value:
                - string
        - name: autoGeneratedDomainNameLabelScope
          value: []
        - name: autoGeneratedDomainNameLabel
          value: string
        - name: teamsVoicemailPilotNumber
          value: string
        - name: onPremMcpEnabled
          value: boolean
        - name: integratedMcpEnabled
          value: boolean
        - name: emergencyDialStrings
          value:
            - string
        - name: dnsDelegations
          value:
            - name: delegations
              value:
                - - name: domain
                    value: string
                  - name: nameServers
                    value:
                      - string
        - name: customSipHeaders
          value:
            - name: headers
              value:
                - - name: name
                    value: string
        - name: allocatedSignalingAddressPrefixes
          value:
            - string
        - name: allocatedMediaAddressPrefixes
          value:
            - string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a communications_gateways resource.

/*+ update */
UPDATE azure.voice_services.communications_gateways
SET 
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
communicationsGatewayName = '{{ communicationsGatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified communications_gateways resource.

/*+ delete */
DELETE FROM azure.voice_services.communications_gateways
WHERE communicationsGatewayName = '{{ communicationsGatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';