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

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
tags	object	Resource tags.

list_by_resource_group

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
tags	object	Resource tags.

list_by_subscription

ARM operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, communicationsGatewayName		Get a CommunicationsGateway
list_by_resource_group	select	subscriptionId, resourceGroupName		List CommunicationsGateway resources by resource group
list_by_subscription	select	subscriptionId		List CommunicationsGateway resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, communicationsGatewayName		Create a CommunicationsGateway
update	update	subscriptionId, resourceGroupName, communicationsGatewayName		Update a CommunicationsGateway
delete	delete	subscriptionId, resourceGroupName, communicationsGatewayName		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
communicationsGatewayName	string	Unique identifier for this deployment
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a CommunicationsGateway

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.voice_services.communications_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND communicationsGatewayName = '{{ communicationsGatewayName }}' -- required
;

list_by_resource_group

List CommunicationsGateway resources by resource group

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

list_by_subscription

List CommunicationsGateway resources by subscription ID

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

INSERT examples

create_or_update

Create a CommunicationsGateway

INSERT INTO azure.voice_services.communications_gateways (
data__properties,
data__identity,
data__sku,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
communicationsGatewayName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ communicationsGatewayName }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: communications_gateways
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the communications_gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the communications_gateways resource.
    - name: communicationsGatewayName
      value: string
      description: Required parameter for the communications_gateways resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: identity
      value: object
      description: |
        The managed service identities assigned to this resource.
    - name: sku
      value: object
      description: |
        The SKU (Stock Keeping Unit) assigned to this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a CommunicationsGateway

UPDATE azure.voice_services.communications_gateways
SET 
data__identity = '{{ identity }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND communicationsGatewayName = '{{ communicationsGatewayName }}' --required
RETURNING
identity,
location,
properties,
sku,
tags;

DELETE examples

delete

Delete a CommunicationsGateway

DELETE FROM azure.voice_services.communications_gateways
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND communicationsGatewayName = '{{ communicationsGatewayName }}' --required
;