az communication email domain

Note

This reference is part of the communication extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az communication email domain command. Learn more about extensions.

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Communication Email Domain.

Commands

Name	Description	Type	Status
az communication email domain cancel-verification	Cancel verification of DNS record.	Extension	Preview
az communication email domain create	Create a new Domains resource under the parent EmailService resource or update an existing Domains resource.	Extension	Preview
az communication email domain delete	Delete to delete a Domains resource.	Extension	Preview
az communication email domain initiate-verification	Initiate verification of DNS record.	Extension	Preview
az communication email domain list	List requests to list all Domains resources under the parent EmailServices resource.	Extension	Preview
az communication email domain sender-username	Manage Communication Email Domain Sender-Username.	Extension	Preview
az communication email domain sender-username create	Create a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.	Extension	Preview
az communication email domain sender-username delete	Delete to delete a SenderUsernames resource.	Extension	Preview
az communication email domain sender-username list	List all valid sender usernames for a domains resource.	Extension	Preview
az communication email domain sender-username show	Get a valid sender username for a domains resource.	Extension	Preview
az communication email domain sender-username update	Update a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.	Extension	Preview
az communication email domain show	Get the Domains resource and its properties.	Extension	Preview
az communication email domain update	Update a new Domains resource under the parent EmailService resource or update an existing Domains resource.	Extension	Preview
az communication email domain wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az communication email domain cancel-verification

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Cancel verification of DNS record.

az communication email domain cancel-verification --verification-type {DKIM, DKIM2, DMARC, Domain, SPF}
                                                  [--domain-name]
                                                  [--email-service-name]
                                                  [--ids]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Cancel Domain Verification

az communication email domain cancel-verification --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --verification-type Domain/SPF/DKIM/DKIM2

Required Parameters

--verification-type

Type of verification.

Property	Value
Parameter group:	Parameters Arguments
Accepted values:	DKIM, DKIM2, DMARC, Domain, SPF

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domain-name

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain create

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az communication email domain create --domain-name --name
                                     --email-service-name
                                     --resource-group
                                     [--domain-management {AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline}]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--tags]
                                     [--user-engmnt-tracking {Disabled, Enabled}]

Examples

Create a domain with tags

az communication email domain create --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --location global --domain-management AzureManaged/CustomerManaged --tags "{tag:tag}" --user-engmnt-tracking Enabled/Disabled

Required Parameters

--domain-name --name -n

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domain-management

Describes how a Domains resource is being managed.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Parameters Arguments
Default value:	Global

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--user-engmnt-tracking

Describes whether user engagement tracking is enabled or disabled.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain delete

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete to delete a Domains resource.

az communication email domain delete [--domain-name --name]
                                     [--email-service-name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

Delete a domain resource

az communication email domain delete --domain-name DomainName --email-service-name ResourceName -g ResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domain-name --name -n

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain initiate-verification

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Initiate verification of DNS record.

az communication email domain initiate-verification --verification-type {DKIM, DKIM2, DMARC, Domain, SPF}
                                                    [--domain-name]
                                                    [--email-service-name]
                                                    [--ids]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Initiate Domain Verification

az communication email domain initiate-verification --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --verification-type Domain/SPF/DKIM/DKIM2

Required Parameters

--verification-type

Type of verification.

Property	Value
Parameter group:	Parameters Arguments
Accepted values:	DKIM, DKIM2, DMARC, Domain, SPF

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domain-name

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain list

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az communication email domain list --email-service-name
                                   --resource-group
                                   [--max-items]
                                   [--next-token]

Examples

Get all domains from a email resource

az communication email domain list --email-service-name ResourceName -g ResourceGroup

Required Parameters

--email-service-name

The name of the EmailService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain show

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the Domains resource and its properties.

az communication email domain show [--domain-name --name]
                                   [--email-service-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]

Examples

Get all domains from a email resource

az communication email domain show --domain-name DomainName --email-service-name ResourceName -g ResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domain-name --name -n

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain update

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az communication email domain update [--add]
                                     [--domain-management {AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline}]
                                     [--domain-name --name]
                                     [--email-service-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--subscription]
                                     [--tags]
                                     [--user-engmnt-tracking {Disabled, Enabled}]

Examples

Update a domain with tags

az communication email domain update --domain-name DomainName  --email-service-name ResourceName -g ResourceGroup --tags "{tag:tag}" --user-engmnt-tracking Enabled/Disabled

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--domain-management

Describes how a Domains resource is being managed.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AzureManaged, CustomerManaged, CustomerManagedInExchangeOnline

--domain-name --name -n

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--user-engmnt-tracking

Describes whether user engagement tracking is enabled or disabled.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az communication email domain wait

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az communication email domain wait [--created]
                                   [--custom]
                                   [--deleted]
                                   [--domain-name --name]
                                   [--email-service-name]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--domain-name --name -n

The name of the Domains resource.

Property	Value
Parameter group:	Resource Id Arguments

--email-service-name

The name of the EmailService resource.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False