az communication email domain
Note
This reference is part of the communication extension for the Azure CLI (version 2.59.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
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
Type of verification.
Optional Parameters
The name of the Domains resource.
The name of the EmailService resource.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain create
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
--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
The name of the Domains resource.
The name of the EmailService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Describes how a Domains resource is being managed.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Describes whether user engagement tracking is enabled or disabled.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain delete
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]
[--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 name of the Domains resource.
The name of the EmailService resource.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain initiate-verification
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
Type of verification.
Optional Parameters
The name of the Domains resource.
The name of the EmailService resource.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain list
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
The name of the EmailService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain show
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]
[--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 name of the Domains resource.
The name of the EmailService resource.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain update
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]
[--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
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>.
Describes how a Domains resource is being managed.
The name of the Domains resource.
The name of the EmailService resource.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Describes whether user engagement tracking is enabled or disabled.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az communication email domain wait
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]
[--email-service-name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
The name of the Domains resource.
The name of the EmailService resource.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.