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

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 Domains resource data is stored at rest.
domainManagement	string	Describes how a Domains resource is being managed. Required. Known values are: "AzureManaged", "CustomerManaged", and "CustomerManagedInExchangeOnline". (AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline)
fromSenderDomain	string	P2 sender domain that is displayed to the email recipients [RFC 5322].
location	string	The geo-location where the resource lives. Required.
mailFromSenderDomain	string	P1 sender domain that is present on the email envelope [RFC 5321].
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)
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".
userEngagementTracking	string	Describes whether user engagement tracking is enabled or disabled. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
verificationRecords	object	List of DnsRecord.
verificationStates	object	List of VerificationStatusRecord.

list_by_email_service_resource

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 Domains resource data is stored at rest.
domainManagement	string	Describes how a Domains resource is being managed. Required. Known values are: "AzureManaged", "CustomerManaged", and "CustomerManagedInExchangeOnline". (AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline)
fromSenderDomain	string	P2 sender domain that is displayed to the email recipients [RFC 5322].
location	string	The geo-location where the resource lives. Required.
mailFromSenderDomain	string	P1 sender domain that is present on the email envelope [RFC 5321].
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)
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".
userEngagementTracking	string	Describes whether user engagement tracking is enabled or disabled. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
verificationRecords	object	List of DnsRecord.
verificationStates	object	List of VerificationStatusRecord.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, email_service_name, domain_name, subscription_id		Get. Get the Domains resource and its properties.
list_by_email_service_resource	select	resource_group_name, email_service_name, subscription_id		List by EmailService. Handles requests to list all Domains resources under the parent EmailServices resource.
create_or_update	insert	resource_group_name, email_service_name, domain_name, subscription_id, location		Create Or Update. Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
update	update	resource_group_name, email_service_name, domain_name, subscription_id		Update. Operation to update an existing Domains resource.
create_or_update	replace	resource_group_name, email_service_name, domain_name, subscription_id, location		Create Or Update. Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
delete	delete	resource_group_name, email_service_name, domain_name, subscription_id		Delete. Operation to delete a Domains resource.
initiate_verification	exec	resource_group_name, email_service_name, domain_name, subscription_id, verificationType		Initiate Verification. Initiate verification of DNS record.
cancel_verification	exec	resource_group_name, email_service_name, domain_name, subscription_id, verificationType		Cancel Verification. 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
domain_name	string	The name of the Domains resource. Required.
email_service_name	string	The name of the EmailService 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 Domains resource and its properties.

SELECT
id,
name,
dataLocation,
domainManagement,
fromSenderDomain,
location,
mailFromSenderDomain,
provisioningState,
systemData,
tags,
type,
userEngagementTracking,
verificationRecords,
verificationStates
FROM azure.communication.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_email_service_resource

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

SELECT
id,
name,
dataLocation,
domainManagement,
fromSenderDomain,
location,
mailFromSenderDomain,
provisioningState,
systemData,
tags,
type,
userEngagementTracking,
verificationRecords,
verificationStates
FROM azure.communication.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the domains resource.
  - name: email_service_name
    value: "{{ email_service_name }}"
    description: Required parameter for the domains resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the domains 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 a Domains resource.
    value:
      provisioningState: "{{ provisioningState }}"
      dataLocation: "{{ dataLocation }}"
      fromSenderDomain: "{{ fromSenderDomain }}"
      mailFromSenderDomain: "{{ mailFromSenderDomain }}"
      domainManagement: "{{ domainManagement }}"
      verificationStates:
        Domain:
          status: "{{ status }}"
          errorCode: "{{ errorCode }}"
        SPF:
          status: "{{ status }}"
          errorCode: "{{ errorCode }}"
        DKIM:
          status: "{{ status }}"
          errorCode: "{{ errorCode }}"
        DKIM2:
          status: "{{ status }}"
          errorCode: "{{ errorCode }}"
        DMARC:
          status: "{{ status }}"
          errorCode: "{{ errorCode }}"
      verificationRecords:
        Domain:
          type: "{{ type }}"
          name: "{{ name }}"
          value: "{{ value }}"
          ttl: {{ ttl }}
        SPF:
          type: "{{ type }}"
          name: "{{ name }}"
          value: "{{ value }}"
          ttl: {{ ttl }}
        DKIM:
          type: "{{ type }}"
          name: "{{ name }}"
          value: "{{ value }}"
          ttl: {{ ttl }}
        DKIM2:
          type: "{{ type }}"
          name: "{{ name }}"
          value: "{{ value }}"
          ttl: {{ ttl }}
        DMARC:
          type: "{{ type }}"
          name: "{{ name }}"
          value: "{{ value }}"
          ttl: {{ ttl }}
      userEngagementTracking: "{{ userEngagementTracking }}"

UPDATE examples

update

Update. Operation to update an existing Domains resource.

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

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Delete. Operation to delete a Domains resource.

DELETE FROM azure.communication.domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

initiate_verification

Initiate Verification. Initiate verification of DNS record.

EXEC azure.communication.domains.initiate_verification 
@resource_group_name='{{ resource_group_name }}' --required, 
@email_service_name='{{ email_service_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"verificationType": "{{ verificationType }}"
}'
;

cancel_verification

Cancel Verification. Cancel verification of DNS record.

EXEC azure.communication.domains.cancel_verification 
@resource_group_name='{{ resource_group_name }}' --required, 
@email_service_name='{{ email_service_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"verificationType": "{{ verificationType }}"
}'
;