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

az communication rooms

Note

This reference is part of the communication extension for the Azure CLI (version 2.67.0 or higher). 该扩展将在首次运行 az communication room 命令时自动安装。 Learn more about extensions.

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

命令

名称	说明	类型	Status
az communication rooms create	新建新房间。	Extension	GA
az communication rooms delete	删除现有会议室。	Extension	GA
az communication rooms get	返回现有聊天室的属性。	Extension	GA
az communication rooms list	列出属于当前通信服务资源的所有活动会议室。	Extension	GA
az communication rooms participant	用于管理现有聊天室参与者的命令。	Extension	GA
az communication rooms participant add-or-update	在聊天室中添加或更新参与者。	Extension	GA
az communication rooms participant get	获取会议室的参与者。	Extension	GA
az communication rooms participant remove	从会议室中删除参与者。	Extension	GA
az communication rooms update	更新现有聊天室的属性。	Extension	GA

az communication rooms create

新建新房间。

az communication rooms create [--attendee-participants --attendees]
                              [--collaborator-participants --collaborators]
                              [--connection-string]
                              [--consumer-participants --consumers]
                              [--presenter-participants --presenters]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

示例

使用默认参数创建会议室

az communication rooms create

创建一个包含有效日期/时间和有效日期/时间的聊天室

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

创建一个具有有效日期/时间和 pstn-dial-out-enabled 的聊天室

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21" --pstn-dial-out-enabled "True"

使用演示者角色的参与者列表创建聊天室

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

创建具有与会者角色的参与者列表的会议室

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

使用演示者和使用者角色的参与者列表创建聊天室

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --consumer-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

创建包含与会者和协作者角色参与者列表的会议室

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --collaborator-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

可选参数

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

--attendee-participants --attendees

要作为与会者邀请到会议室的标识集合。 Optional.

--collaborator-participants --collaborators

要作为协作者邀请到会议室的标识集合。 Optional.

--connection-string

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

属性	值
Parameter group:	Communication Arguments

--consumer-participants --consumers

要作为使用者邀请到会议室的标识集合。 Optional.

--presenter-participants --presenters

要作为演示者邀请到会议室的标识集合。 Optional.

--pstn-dial-out-enabled

如果在呼叫时在特定房间中启用 PSTN 号码，请将此标志设置为 true。默认情况下，此标志设置为 false。 Optional.

--valid-from

打开聊天室以ISO8601格式（例如：2023-03-31T10：21）的时间戳。 Optional.

--valid-until

无法再加入房间时的时间戳，格式为ISO8601，例如：2023-06-31T10：21。 Optional.

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az communication rooms delete

删除现有会议室。

az communication rooms delete --room
                              [--connection-string]
                              [--yes]

示例

删除现有会议室

az communication rooms delete --room "12345678901234567"

必需参数

--room

Room Id.

可选参数

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

--connection-string

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

属性	值
Parameter group:	Communication Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az communication rooms get

返回现有聊天室的属性。

az communication rooms get --room
                           [--connection-string]

示例

Get room

az communication rooms get --room "12345678901234567"

必需参数

--room

Room Id.

可选参数

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

--connection-string

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

属性	值
Parameter group:	Communication Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az communication rooms list

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

az communication rooms list [--connection-string]

示例

列出所有活动会议室

az communication rooms list

可选参数

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

--connection-string

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

属性	值
Parameter group:	Communication Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az communication rooms update

更新现有聊天室的属性。

az communication rooms update --room
                              [--connection-string]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

示例

更新聊天室的有效期和有效到属性

az communication rooms update --room "12345678901234567" --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

必需参数

--room

Room Id.

可选参数

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

--connection-string

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

属性	值
Parameter group:	Communication Arguments

--pstn-dial-out-enabled

如果在呼叫时在特定房间中启用 PSTN 号码，请将此标志设置为 true。默认情况下，此标志设置为 false。 Optional.

--valid-from

打开聊天室以ISO8601格式（例如：2023-03-31T10：21）的时间戳。应与 --valid-until 一起使用。 Optional.

--valid-until

无法再加入房间时的时间戳，格式为ISO8601，例如：2023-06-31T10：21。应与 --valid-from 一起使用。 Optional.

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

通过

az communication rooms

命令

az communication rooms create

示例

可选参数

az communication rooms delete

示例

必需参数

可选参数

az communication rooms get

示例

必需参数

可选参数

az communication rooms list

示例

可选参数

az communication rooms update

示例

必需参数

可选参数

反馈