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

az webpubsub service connection

注释

此参考是 Azure CLI 的 webpubsub 扩展（版本 2.56.0 或更高版本）的一部分。 该扩展将在首次运行 az webpubsub service connection 命令时自动安装。 了解更多关于扩展 的相关信息。

用于管理 Webpubsub 服务连接的命令。

命令

名称	说明	类型	Status
az webpubsub service connection close	关闭特定的客户端连接。 如果作失败，则引发错误。	扩展	GA
az webpubsub service connection exist	检查客户端连接是否存在。	扩展	GA
az webpubsub service connection send	向连接发送消息。 如果作失败，则引发错误。	扩展	GA

az webpubsub service connection close

关闭特定的客户端连接。 如果作失败，则引发错误。

az webpubsub service connection close --connection-id
                                      --hub-name
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

必需参数

--connection-id

连接 ID。

--hub-name

要管理的中心。

可选参数

--ids

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

--name -n

Webpubsub 的名称。

--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 webpubsub service connection exist

检查客户端连接是否存在。

az webpubsub service connection exist --connection-id
                                      --hub-name
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

必需参数

--connection-id

连接 ID。

--hub-name

要管理的中心。

可选参数

--ids

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

--name -n

Webpubsub 的名称。

--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 webpubsub service connection send

向连接发送消息。 如果作失败，则引发错误。

az webpubsub service connection send --connection-id
                                     --hub-name
                                     --payload
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

必需参数

--connection-id

连接 ID。

--hub-name

要管理的中心。

--payload

要发送的字符串有效负载。

可选参数

--ids

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

--name -n

Webpubsub 的名称。

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