domains

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

Overview

Name	domains
Type	Resource
Id	azure.communication.domains

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the corresponding Domains resource.

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

list_by_email_service_resource

Success. The response describes the list of Domains resources under the parent EmailServices resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties of a Domains 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, emailServiceName, domainName		Get the Domains resource and its properties.
list_by_email_service_resource	select	subscriptionId, resourceGroupName, emailServiceName		Handles requests to list all Domains resources under the parent EmailServices resource.
create_or_update	insert	subscriptionId, resourceGroupName, emailServiceName, domainName		Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
update	update	subscriptionId, resourceGroupName, emailServiceName, domainName		Operation to update an existing Domains resource.
delete	delete	subscriptionId, resourceGroupName, emailServiceName, domainName		Operation to delete a Domains resource.
initiate_verification	exec	subscriptionId, resourceGroupName, emailServiceName, domainName, verificationType		Initiate verification of DNS record.
cancel_verification	exec	subscriptionId, resourceGroupName, emailServiceName, domainName, verificationType		Cancel verification of DNS record.

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
domainName	string	The name of the Domains resource.
emailServiceName	string	The name of the EmailService resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the Domains resource and its properties.

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

list_by_email_service_resource

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

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

INSERT examples

create_or_update

Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.

INSERT INTO azure.communication.domains (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
emailServiceName,
domainName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ emailServiceName }}',
'{{ domainName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: domains
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the domains resource.
    - name: emailServiceName
      value: string
      description: Required parameter for the domains resource.
    - name: domainName
      value: string
      description: Required parameter for the domains resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The properties of a Domains resource.

UPDATE examples

update

Operation to update an existing Domains resource.

UPDATE azure.communication.domains
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND emailServiceName = '{{ emailServiceName }}' --required
AND domainName = '{{ domainName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Operation to delete a Domains resource.

DELETE FROM azure.communication.domains
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND emailServiceName = '{{ emailServiceName }}' --required
AND domainName = '{{ domainName }}' --required
;

Lifecycle Methods

initiate_verification

Initiate verification of DNS record.

EXEC azure.communication.domains.initiate_verification 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@emailServiceName='{{ emailServiceName }}' --required, 
@domainName='{{ domainName }}' --required 
@@json=
'{
"verificationType": "{{ verificationType }}"
}'
;

cancel_verification

Cancel verification of DNS record.

EXEC azure.communication.domains.cancel_verification 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@emailServiceName='{{ emailServiceName }}' --required, 
@domainName='{{ domainName }}' --required 
@@json=
'{
"verificationType": "{{ verificationType }}"
}'
;