services

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

Overview

Name	services
Type	Resource
Id	azure.communication.services

Fields

vw_services

Name	Datatype	Description
communicationServiceName	text	field from the properties object
data_location	text	field from the properties object
host_name	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
immutable_resource_id	text	field from the properties object
linked_domains	text	field from the properties object
location	text	The geo-location where the resource lives
notification_hub_id	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
version	text	field from the properties object

services

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	A class that describes the properties of the CommunicationService.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	communicationServiceName, resourceGroupName, subscriptionId	Get the CommunicationService and its properties.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Handles requests to list all resources in a resource group.
list_by_subscription	SELECT	subscriptionId	Handles requests to list all resources in a subscription.
create_or_update	INSERT	communicationServiceName, resourceGroupName, subscriptionId	Create a new CommunicationService or update an existing CommunicationService.
delete	DELETE	communicationServiceName, resourceGroupName, subscriptionId	Operation to delete a CommunicationService.
update	UPDATE	communicationServiceName, resourceGroupName, subscriptionId	Operation to update an existing CommunicationService.
check_name_availability	EXEC	subscriptionId, data__name, data__type	Checks that the CommunicationService name is valid and is not already in use.
link_notification_hub	EXEC	communicationServiceName, resourceGroupName, subscriptionId, data__connectionString, data__resourceId	Links an Azure Notification Hub to this communication service.
regenerate_key	EXEC	communicationServiceName, resourceGroupName, subscriptionId	Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

SELECT examples

Handles requests to list all resources in a subscription.

vw_services

SELECT
communicationServiceName,
data_location,
host_name,
identity,
immutable_resource_id,
linked_domains,
location,
notification_hub_id,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
version
FROM azure.communication.vw_services
WHERE subscriptionId = '{{ subscriptionId }}';

services

SELECT
identity,
location,
properties,
tags
FROM azure.communication.services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.communication.services (
communicationServiceName,
resourceGroupName,
subscriptionId,
tags,
location,
properties,
identity
)
SELECT 
'{{ communicationServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: hostName
          value: string
        - name: dataLocation
          value: string
        - name: notificationHubId
          value: string
        - name: version
          value: string
        - name: immutableResourceId
          value: string
        - name: linkedDomains
          value: []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure.communication.services
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
communicationServiceName = '{{ communicationServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM azure.communication.services
WHERE communicationServiceName = '{{ communicationServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';