domains

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

Overview

Name	domains
Type	Resource
Id	azure.communication.domains

Fields

vw_domains

Name	Datatype	Description
data_location	text	field from the properties object
domainName	text	field from the properties object
domain_management	text	field from the properties object
emailServiceName	text	field from the properties object
from_sender_domain	text	field from the properties object
location	text	The geo-location where the resource lives
mail_from_sender_domain	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.
user_engagement_tracking	text	field from the properties object
verification_records	text	field from the properties object
verification_states	text	field from the properties object

domains

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	A class that describes the properties of a Domains resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	domainName, emailServiceName, resourceGroupName, subscriptionId	Get the Domains resource and its properties.
list_by_email_service_resource	SELECT	emailServiceName, resourceGroupName, subscriptionId	Handles requests to list all Domains resources under the parent EmailServices resource.
create_or_update	INSERT	domainName, emailServiceName, resourceGroupName, subscriptionId	Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
delete	DELETE	domainName, emailServiceName, resourceGroupName, subscriptionId	Operation to delete a Domains resource.
update	UPDATE	domainName, emailServiceName, resourceGroupName, subscriptionId	Operation to update an existing Domains resource.
cancel_verification	EXEC	domainName, emailServiceName, resourceGroupName, subscriptionId, data__verificationType	Cancel verification of DNS record.
initiate_verification	EXEC	domainName, emailServiceName, resourceGroupName, subscriptionId, data__verificationType	Initiate verification of DNS record.

SELECT examples

Handles requests to list all Domains resources under the parent EmailServices resource.

vw_domains

SELECT
data_location,
domainName,
domain_management,
emailServiceName,
from_sender_domain,
location,
mail_from_sender_domain,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
user_engagement_tracking,
verification_records,
verification_states
FROM azure.communication.vw_domains
WHERE emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

domains

SELECT
location,
properties,
tags
FROM azure.communication.domains
WHERE emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.communication.domains (
domainName,
emailServiceName,
resourceGroupName,
subscriptionId,
tags,
location,
properties
)
SELECT 
'{{ domainName }}',
'{{ emailServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: dataLocation
          value: string
        - name: fromSenderDomain
          value: string
        - name: mailFromSenderDomain
          value: string
        - name: domainManagement
          value: []
        - name: verificationStates
          value:
            - name: Domain
              value:
                - name: status
                  value: string
                - name: errorCode
                  value: string
        - name: verificationRecords
          value:
            - name: Domain
              value:
                - name: type
                  value: string
                - name: name
                  value: string
                - name: value
                  value: string
                - name: ttl
                  value: integer
        - name: userEngagementTracking
          value: []

UPDATE example

Updates a domains resource.

/*+ update */
UPDATE azure.communication.domains
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
domainName = '{{ domainName }}'
AND emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified domains resource.

/*+ delete */
DELETE FROM azure.communication.domains
WHERE domainName = '{{ domainName }}'
AND emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';