Share via

az communication email

  • Preview
  • Reference

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 command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Communication Email.

Commands

Name Description Type Status
az communication email create

Create a new EmailService or update an existing EmailService.

 Extension Preview
az communication email delete

Delete to delete a EmailService.

 Extension Preview
az communication email domain

Manage Communication Email Domain.

 Extension Preview
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 list

List requests to list all resources in a subscription.

 Extension Preview
az communication email send

Send an email and get final status.

 Extension Preview
az communication email show

Get the EmailService and its properties.

 Extension Preview
az communication email status

Commands to get the status of emails previously sent using Azure Communication Services Email service.

 Extension Preview
az communication email status get

Get status of an email previously sent.

 Extension Preview
az communication email update

Update a new EmailService or update an existing EmailService.

 Extension Preview
az communication email wait

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

 Extension Preview

az communication email create

Preview

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

Create a new EmailService or update an existing EmailService.

az communication email create --data-location
                              --email-service-name
                              --resource-group
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]

Examples

Create a email resource with tags

az communication email create -n ResourceName -g ResourceGroup --location global --data-location unitedstates --tags "{tag:tag}"

Required Parameters

--data-location

The location where the email service stores its data at rest.

--email-service-name --name -n

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

--location -l

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

Default value: Global
--no-wait

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

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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email 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 EmailService.

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

Examples

Delete a email resource

az communication email delete -n ResourceName -g ResourceGroup

Optional Parameters

--email-service-name --name -n

The name of the EmailService resource.

--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.

--no-wait

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

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>.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email 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 resources in a subscription.

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

Examples

Get all resources from a subscription

az communication email list --subscription SubscriptionId

Get all resources from a resource group

az communication email list -g ResourceGroup

Optional Parameters

--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.

--next-token

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

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email send

Preview

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

Send an email and get final status.

az communication email send --sender
                            --subject
                            [--attachment-types]
                            [--attachments]
                            [--bcc]
                            [--cc]
                            [--connection-string]
                            [--disable-tracking {false, true}]
                            [--html]
                            [--importance {high, low, normal}]
                            [--inline-attachments]
                            [--reply-to]
                            [--text]
                            [--to]
                            [--wait-until {0, 1, completed, started}]

Examples

Send an email from an existing domain

az communication email send --sender "[email protected]" --subject "Contoso Update" --to "[email protected]" "[email protected]" --text "Hello valued client. There is an update."

Required Parameters

--sender

Sender email address from a verified domain.

--subject

Subject of the email message.

Optional Parameters

--attachment-types

List of email attachment types and inline attachment types, in the same order of attachments followed by inline attachments. Required for each attachment. Known values for attachments are: avi, bmp, doc, docm, docx, gif, jpeg, mp3, one, pdf, png, ppsm, ppsx, ppt, pptm, pptx, pub, rpmsg, rtf, tif, txt, vsd, wav, wma, xls, xlsb, xlsm, and xlsx.

--attachments

List of email attachments. Optional.

--bcc

Blind carbon copy email addresses.

--cc

Carbon copy email addresses.

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

--disable-tracking

Indicates whether user engagement tracking should be disabled for this specific request. This is only applicable if the resource-level user engagement tracking setting was already enabled in control plane. Optional.

Accepted values: false, true
Default value: False
--html

Html version of the email message. Optional.

--importance

The importance type for the email. Known values are: high, normal, and low. Default is normal. Optional.

Accepted values: high, low, normal
Default value: normal
--inline-attachments

List of inline attachments. Optional. Format: FileLocation/ContentId example: "ImageName.png/image".

--reply-to

Reply-to email address. Optional.

--text

Plain text version of the email message. Optional.

--to

Recepients email addresses comma seperated if more than one.

--wait-until

Indicates whether to wait until the server operation is started or completed. Accepted values are: started, completed, 1, 0.

Accepted values: 0, 1, completed, started
Default value: completed
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email show

Preview

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

Get the EmailService and its properties.

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

Examples

Get a email service's properties

az communication email show -n ResourceName -g ResourceGroup

Optional Parameters

--email-service-name --name -n

The name of the EmailService resource.

--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.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email update

Preview

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

Update a new EmailService or update an existing EmailService.

az communication email update [--add]
                              [--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]

Examples

Update a email resource with tags

az communication email update -n ResourceName -g ResourceGroup --tags "{tag:tag}"

Optional Parameters

--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>.

--email-service-name --name -n

The name of the EmailService resource.

--force-string

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

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.

--no-wait

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

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.

--resource-group -g

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

--set

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

--subscription

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

--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az communication email 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 wait [--created]
                            [--custom]
                            [--deleted]
                            [--email-service-name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--email-service-name --name -n

The name of the EmailService resource.

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.