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

az communication

注意

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

使用通信管理通信服务。

命令

名称 说明 类型 状态
az communication chat

用于与Azure 通信服务聊天网关交互的命令。

扩展 预览
az communication chat message

用于管理通信服务资源的聊天线程中的消息的命令。

扩展 预览
az communication chat message delete

按 ID 从聊天线程中删除消息。

扩展 预览
az communication chat message get

按 ID 从聊天线程获取消息。

扩展 预览
az communication chat message list

从聊天线程获取消息列表。

扩展 预览
az communication chat message receipt

用于在通信服务资源的聊天线程中管理消息读回执的命令。

扩展 预览
az communication chat message receipt list

获取聊天线程的已读回执。

扩展 预览
az communication chat message receipt send

代表用户将已读回执事件发布到聊天线程。

扩展 预览
az communication chat message send

向聊天线程发送消息。

扩展 预览
az communication chat message update

汇报消息。

扩展 预览
az communication chat participant

用于管理通信服务资源的聊天线程中的参与者的命令。

扩展 预览
az communication chat participant add

将参与者添加到聊天线程。

扩展 预览
az communication chat participant list

获取聊天线程的参与者。

扩展 预览
az communication chat participant remove

从聊天会话中删除参与者。

扩展 预览
az communication chat thread

用于管理通信服务资源的聊天线程的命令。

扩展 预览
az communication chat thread create

创建聊天线程。

扩展 预览
az communication chat thread delete

删除聊天线程。

扩展 预览
az communication chat thread list

获取用户的聊天线程列表。

扩展 预览
az communication chat thread update-topic

汇报聊天线程的主题。

扩展 预览
az communication create

创建新的 CommunicationService 或更新现有的 CommunicationService。

扩展 GA
az communication delete

删除以删除 CommunicationService。

扩展 GA
az communication email

管理通信电子邮件。

扩展 GA
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 identity

管理通信资源的托管标识。

扩展 GA
az communication identity assign

将托管标识分配给通信资源。

扩展 GA
az communication identity remove

从通信资源中删除托管标识。

扩展 GA
az communication identity show

显示通信资源的托管标识。

扩展 GA
az communication identity token

用于管理通信服务资源的用户令牌的命令。

扩展 已放弃
az communication identity token get-for-teams-user

将 Teams 用户的 Azure Active Directory (Azure AD) 访问令牌交换为具有匹配过期时间的新 ACS 标识访问令牌。

扩展 已放弃
az communication identity token issue

颁发具有给定用户标识的指定范围的新访问令牌。 如果未指定用户标识,则也会创建新的用户标识。

扩展 已放弃
az communication identity token revoke

撤销特定 ACS 标识的所有访问令牌。

扩展 已放弃
az communication identity user

用于管理通信服务资源的用户标识的命令。

扩展 已放弃
az communication identity user create

创建新的 ACS 标识。

扩展 已放弃
az communication identity user delete

删除现有的 ACS 标识,撤销该 ACS 标识的所有令牌,并删除所有关联的数据。

扩展 已放弃
az communication identity wait

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

扩展 GA
az communication link-notification-hub

将 Azure 通知中心链接到此通信服务。

扩展 GA
az communication list

列出列出列出资源组中的所有资源的请求。

扩展 GA
az communication list-key

获取 CommunicationService 资源的访问密钥。

扩展 GA
az communication phonenumber

用于管理通信服务资源的电话号码的命令。

扩展 预览
az communication phonenumber list

列出与通信服务资源关联的所有电话号码。

扩展 预览
az communication phonenumber show

显示与通信服务资源关联的电话号码的详细信息。

扩展 预览
az communication phonenumbers

用于管理通信服务资源的电话号码的命令。

扩展 已放弃
az communication phonenumbers list-phonenumbers

列出与通信服务资源关联的所有电话号码。

扩展 已放弃
az communication phonenumbers show-phonenumber

显示与通信服务资源关联的电话号码的详细信息。

扩展 已放弃
az communication regenerate-key

重新生成 CommunicationService 访问密钥。 无法同时重新生成 PrimaryKey 和 SecondaryKey。

扩展 GA
az communication rooms

用于与Azure 通信服务会议室网关交互的命令。

扩展 GA
az communication rooms create

新建新房间。

扩展 GA
az communication rooms delete

删除现有会议室。

扩展 GA
az communication rooms get

返回现有聊天室的属性。

扩展 GA
az communication rooms list

列出属于当前通信服务资源的所有活动会议室。

扩展 GA
az communication rooms participant

用于管理现有聊天室参与者的命令。

扩展 GA
az communication rooms participant add-or-update

在聊天室中添加或更新参与者。

扩展 GA
az communication rooms participant get

获取会议室的参与者。

扩展 GA
az communication rooms participant remove

从会议室中删除参与者。

扩展 GA
az communication rooms update

更新现有聊天室的属性。

扩展 GA
az communication show

获取 CommunicationService 及其属性。

扩展 GA
az communication sms

用于管理通信服务资源的短信的命令。

扩展 GA
az communication sms send

将发送方电话号码中的短信发送到接收方电话号码(s)。

扩展 预览
az communication sms send-sms

将发送方电话号码中的短信发送到接收方电话号码(s)。

扩展 已放弃
az communication update

更新新的 CommunicationService 或更新现有的 CommunicationService。

扩展 GA
az communication user-identity

用于管理通信服务资源的用户标识及其令牌的命令。

扩展 预览
az communication user-identity issue-access-token

颁发具有给定用户标识的指定范围的新访问令牌。 如果未指定用户标识,则也会创建新的用户标识。

扩展 预览和弃用
az communication user-identity token

用于管理通信服务资源的用户令牌的命令。

扩展 预览
az communication user-identity token get-for-teams-user

将 Teams 用户的 Azure Active Directory (Azure AD) 访问令牌交换为具有匹配过期时间的新 ACS 标识访问令牌。

扩展 预览
az communication user-identity token issue

颁发具有给定用户标识的指定范围的新访问令牌。 如果未指定用户标识,则也会创建新的用户标识。

扩展 预览
az communication user-identity token revoke

撤销特定 ACS 标识的所有访问令牌。

扩展 预览
az communication user-identity user

用于管理通信服务资源的用户标识的命令。

扩展 预览
az communication user-identity user create

创建新的 ACS 标识。

扩展 预览
az communication user-identity user delete

删除现有的 ACS 标识,撤销该 ACS 标识的所有令牌,并删除所有关联的数据。

扩展 预览
az communication wait

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

扩展 GA

az communication create

创建新的 CommunicationService 或更新现有的 CommunicationService。

az communication create --data-location
                        --name
                        --resource-group
                        [--linked-domains]
                        [--location]
                        [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                        [--mi-user-assigned]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--tags]

必需参数

--data-location

通信服务存储静态数据的位置。

--name -n

CommunicationService 资源的名称。

--resource-group -g

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

可选参数

--linked-domains

电子邮件域资源 ID 的列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--location -l

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

--mi-system-assigned

启用系统分配的标识。

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

用空格分隔的资源 ID 添加用户分配的标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

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

删除以删除 CommunicationService。

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

可选参数

--ids

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

--name -n

CommunicationService 资源的名称。

--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 获取完整的调试日志。

将 Azure 通知中心链接到此通信服务。

az communication link-notification-hub [--connection-string]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--resource-id]
                                       [--subscription]
--connection-string

通知中心的连接字符串。

--ids

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

--name -n

CommunicationService 资源的名称。

--resource-group -g

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

--resource-id

通知中心的资源 ID。

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

列出列出列出资源组中的所有资源的请求。

az communication list [--resource-group]

可选参数

--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 list-key

获取 CommunicationService 资源的访问密钥。

az communication list-key [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

可选参数

--ids

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

--name -n

CommunicationService 资源的名称。

--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 regenerate-key

重新生成 CommunicationService 访问密钥。 无法同时重新生成 PrimaryKey 和 SecondaryKey。

az communication regenerate-key [--ids]
                                [--key-type {Primary, Secondary}]
                                [--name]
                                [--resource-group]
                                [--subscription]

可选参数

--ids

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

--key-type

要重新生成的 keyType。 必须是“primary”或“secondary”(不区分大小写)。

接受的值: Primary, Secondary
--name -n

CommunicationService 资源的名称。

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

获取 CommunicationService 及其属性。

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

可选参数

--ids

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

--name -n

CommunicationService 资源的名称。

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

更新新的 CommunicationService 或更新现有的 CommunicationService。

az communication update [--add]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--linked-domains]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
                        [--tags]
                        [--type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                        [--user-assigned-identities]

可选参数

--add

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

--force-string

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

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

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

--linked-domains

电子邮件域资源 ID 的列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--name -n

CommunicationService 资源的名称。

--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。 请尝试“??” 以显示更多内容。

--type

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

接受的值: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--user-assigned-identities -i

与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 支持速记语法、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 wait

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

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

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

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

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name -n

CommunicationService 资源的名称。

--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 获取完整的调试日志。