你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az communication email

参考

注意

此参考是 Azure CLI（版本 2.59.0 或更高版本）的通信扩展的一部分。该扩展将在首次运行 az communication email 命令时自动安装。详细了解扩展。

管理通信电子邮件。

命令

名称	说明	类型	状态
az communication email create	创建新的 EmailService 或更新现有的 EmailService。	扩展	GA
az communication email delete	删除以删除 EmailService。	扩展	GA
az communication email domain	管理通信电子邮件域。	扩展	GA
az communication email domain cancel-verification	取消 DNS 记录的验证。	扩展	GA
az communication email domain create	在父 EmailService 资源下创建新的域资源或更新现有域资源。	扩展	GA
az communication email domain delete	删除以删除域资源。	扩展	GA
az communication email domain initiate-verification	启动 DNS 记录的验证。	扩展	GA
az communication email domain list	列出列出父 EmailServices 资源下所有域资源的请求。	扩展	GA
az communication email domain sender-username	管理通信电子邮件域发件人用户名。	扩展	GA
az communication email domain sender-username create	在父域资源下创建新的 SenderUsername 资源，或更新现有的 SenderUsername 资源。	扩展	GA
az communication email domain sender-username delete	删除以删除 SenderUsernames 资源。	扩展	GA
az communication email domain sender-username list	列出域资源的所有有效发件人用户名。	扩展	GA
az communication email domain sender-username show	获取域资源的有效发件人用户名。	扩展	GA
az communication email domain sender-username update	在父域资源下更新新的 SenderUsername 资源，或更新现有的 SenderUsername 资源。	扩展	GA
az communication email domain show	获取域资源及其属性。	扩展	GA
az communication email domain update	在父 EmailService 资源下更新新的域资源或更新现有域资源。	扩展	GA
az communication email domain wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA
az communication email list	列出列出请求以列出订阅中的所有资源。	扩展	GA
az communication email send	发送电子邮件并获取最终状态。	扩展	GA
az communication email show	获取 EmailService 及其属性。	扩展	GA
az communication email update	更新新的 EmailService 或更新现有的 EmailService。	扩展	GA
az communication email wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az communication email create

创建新的 EmailService 或更新现有的 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]

示例

使用标记创建电子邮件资源

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

必需参数

--data-location

电子邮件服务存储静态数据的位置。

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

EmailService 资源的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

默认值: Global

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email delete

删除以删除 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]

示例

删除电子邮件资源

az communication email delete -n ResourceName -g ResourceGroup

可选参数

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

EmailService 资源的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email list

列出列出请求以列出订阅中的所有资源。

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

示例

从订阅获取所有资源

az communication email list --subscription SubscriptionId

从资源组获取所有资源

az communication email list -g ResourceGroup

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email send

发送电子邮件并获取最终状态。

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

示例

从现有域发送电子邮件

az communication email send --sender "NoReply@contoso.com" --subject "Contoso Update" --to "user1@user1-domain.com" "user2@user2-domain.com" --text "Hello valued client. There is an update."

必需参数

--sender

来自已验证域的发件人电子邮件地址。

--subject

电子邮件的主题。

可选参数

--attachment-types

以相同顺序排列的电子邮件附件类型列表。每个附件都是必需的。已知值为：avi、bmp、doc、doc、docx、gif、jpeg、mp3、one、pdf、png、ppsm、ppsx、ppt、pptm、pptx、pub、rpmsg、rtf、tif、txt、vsd、wav、wma、xlsb、xlsm 和 xlsx。

--attachments

电子邮件附件列表。可选。

--bcc

盲件抄送电子邮件地址。

--cc

抄送电子邮件地址。

--connection-string

通信连接字符串。环境变量：AZURE_COMMUNICATION_CONNECTION_STRING。

--disable-tracking

指示是否应为此特定请求禁用用户参与跟踪。仅当已在控制平面中启用资源级用户参与跟踪设置时，这才适用。可选。

接受的值: false, true

默认值: False

--html

电子邮件的 Html 版本。可选。

--importance

电子邮件的重要性类型。已知值为：high、normal 和 low。默认值为 normal。可选。

接受的值: high, low, normal

默认值: normal

--reply-to

回复电子邮件地址。可选。

--text

电子邮件的纯文本版本。可选。

--to

如果有多个电子邮件地址，请重新定位逗号分隔。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email show

获取 EmailService 及其属性。

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

示例

获取电子邮件服务的属性

az communication email show -n ResourceName -g ResourceGroup

可选参数

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

EmailService 资源的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email update

更新新的 EmailService 或更新现有的 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]

示例

使用标记更新电子邮件资源

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

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

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

EmailService 资源的名称。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az communication email wait

将 CLI 置于等待状态，直到满足条件。

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

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

EmailService 资源的名称。

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az communication email

命令

az communication email create

示例

必需参数

可选参数

az communication email delete

示例

可选参数

az communication email list

示例

可选参数

az communication email send

示例

必需参数

可选参数

az communication email show

示例

可选参数

az communication email update

示例

可选参数

az communication email wait

可选参数

其他资源