communication_services

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

Overview

Name	communication_services
Type	Resource
Id	azure.communication.communication_services

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.
dataLocation	string	The location where the communication service stores its data at rest. Required.
disableLocalAuth	boolean	Disable local authentication for the CommunicationService.
hostName	string	FQDN of the CommunicationService instance.
identity	object	The managed service identities assigned to this resource.
immutableResourceId	string	The immutable resource Id of the communication service.
linkedDomains	array	List of email Domain resource Ids.
location	string	The geo-location where the resource lives. Required.
notificationHubId	string	Resource ID of an Azure Notification Hub linked to this resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
publicNetworkAccess	string	Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.

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.
dataLocation	string	The location where the communication service stores its data at rest. Required.
disableLocalAuth	boolean	Disable local authentication for the CommunicationService.
hostName	string	FQDN of the CommunicationService instance.
identity	object	The managed service identities assigned to this resource.
immutableResourceId	string	The immutable resource Id of the communication service.
linkedDomains	array	List of email Domain resource Ids.
location	string	The geo-location where the resource lives. Required.
notificationHubId	string	Resource ID of an Azure Notification Hub linked to this resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
publicNetworkAccess	string	Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.

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.
dataLocation	string	The location where the communication service stores its data at rest. Required.
disableLocalAuth	boolean	Disable local authentication for the CommunicationService.
hostName	string	FQDN of the CommunicationService instance.
identity	object	The managed service identities assigned to this resource.
immutableResourceId	string	The immutable resource Id of the communication service.
linkedDomains	array	List of email Domain resource Ids.
location	string	The geo-location where the resource lives. Required.
notificationHubId	string	Resource ID of an Azure Notification Hub linked to this resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
publicNetworkAccess	string	Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, communication_service_name, subscription_id		Get. Get the CommunicationService and its properties.
list_by_resource_group	select	resource_group_name, subscription_id		List By Resource Group. Handles requests to list all resources in a resource group.
list_by_subscription	select	subscription_id		List By Subscription. Handles requests to list all resources in a subscription.
create_or_update	insert	resource_group_name, communication_service_name, subscription_id, location		Create Or Update. Create a new CommunicationService or update an existing CommunicationService.
update	update	resource_group_name, communication_service_name, subscription_id		Update. Operation to update an existing CommunicationService.
create_or_update	replace	resource_group_name, communication_service_name, subscription_id, location		Create Or Update. Create a new CommunicationService or update an existing CommunicationService.
delete	delete	resource_group_name, communication_service_name, subscription_id		Delete. Operation to delete a CommunicationService.
list_keys	exec	resource_group_name, communication_service_name, subscription_id		List Keys. Get the access keys of the CommunicationService resource.
link_notification_hub	exec	resource_group_name, communication_service_name, subscription_id, resourceId, connectionString		Link Notification Hub. Links an Azure Notification Hub to this communication service.
regenerate_key	exec	resource_group_name, communication_service_name, subscription_id		Regenerate Key. Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
check_name_availability	exec	subscription_id		Check Name Availability. Checks that the CommunicationService name is valid and is not already in use.

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
communication_service_name	string	The name of the CommunicationService resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get. Get the CommunicationService and its properties.

SELECT
id,
name,
dataLocation,
disableLocalAuth,
hostName,
identity,
immutableResourceId,
linkedDomains,
location,
notificationHubId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type,
version
FROM azure.communication.communication_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communication_service_name = '{{ communication_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List By Resource Group. Handles requests to list all resources in a resource group.

SELECT
id,
name,
dataLocation,
disableLocalAuth,
hostName,
identity,
immutableResourceId,
linkedDomains,
location,
notificationHubId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type,
version
FROM azure.communication.communication_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List By Subscription. Handles requests to list all resources in a subscription.

SELECT
id,
name,
dataLocation,
disableLocalAuth,
hostName,
identity,
immutableResourceId,
linkedDomains,
location,
notificationHubId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type,
version
FROM azure.communication.communication_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update. Create a new CommunicationService or update an existing CommunicationService.

INSERT INTO azure.communication.communication_services (
tags,
location,
properties,
identity,
resource_group_name,
communication_service_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ communication_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: communication_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the communication_services resource.
  - name: communication_service_name
    value: "{{ communication_service_name }}"
    description: Required parameter for the communication_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the communication_services resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties of the service.
    value:
      provisioningState: "{{ provisioningState }}"
      hostName: "{{ hostName }}"
      dataLocation: "{{ dataLocation }}"
      notificationHubId: "{{ notificationHubId }}"
      version: "{{ version }}"
      immutableResourceId: "{{ immutableResourceId }}"
      linkedDomains:
        - "{{ linkedDomains }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      disableLocalAuth: {{ disableLocalAuth }}
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update. Operation to update an existing CommunicationService.

UPDATE azure.communication.communication_services
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communication_service_name = '{{ communication_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create Or Update. Create a new CommunicationService or update an existing CommunicationService.

REPLACE azure.communication.communication_services
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communication_service_name = '{{ communication_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete. Operation to delete a CommunicationService.

DELETE FROM azure.communication.communication_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND communication_service_name = '{{ communication_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_keys

List Keys. Get the access keys of the CommunicationService resource.

EXEC azure.communication.communication_services.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@communication_service_name='{{ communication_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

link_notification_hub

Link Notification Hub. Links an Azure Notification Hub to this communication service.

EXEC azure.communication.communication_services.link_notification_hub 
@resource_group_name='{{ resource_group_name }}' --required, 
@communication_service_name='{{ communication_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceId": "{{ resourceId }}", 
"connectionString": "{{ connectionString }}"
}'
;

regenerate_key

Regenerate Key. Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

EXEC azure.communication.communication_services.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@communication_service_name='{{ communication_service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

check_name_availability

Check Name Availability. Checks that the CommunicationService name is valid and is not already in use.

EXEC azure.communication.communication_services.check_name_availability 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;