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

az webpubsub service

注意

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

用于管理 Webpubsub 服务的命令。

命令

名称	说明	类型	状态
az webpubsub service broadcast	将消息广播到中心。 如果操作失败，则引发错误。	分机	GA
az webpubsub service connection	用于管理 Webpubsub 服务连接的命令。	分机	GA
az webpubsub service connection close	关闭特定的客户端连接。 如果操作失败，则引发错误。	分机	GA
az webpubsub service connection exist	检查客户端连接是否存在。	扩展	GA
az webpubsub service connection send	向连接发送消息。 如果操作失败，则引发错误。	分机	GA
az webpubsub service group	用于管理 Webpubsub 服务组的命令。	扩展	GA
az webpubsub service group add-connection	将连接添加到组。 如果操作失败，则引发错误。	分机	GA
az webpubsub service group add-user	将用户添加到组。 如果操作失败，则引发错误。	分机	GA
az webpubsub service group remove-connection	从组中删除连接。 如果操作失败，则引发错误。	分机	GA
az webpubsub service group remove-user	从组中删除用户。 如果操作失败，则引发错误。	扩展	GA
az webpubsub service group send	将消息发送到组。 如果操作失败，则引发错误。	扩展	GA
az webpubsub service permission	用于管理 Webpubsub 服务权限的命令。	分机	GA
az webpubsub service permission check	检查连接是否具有对指定组的权限。	分机	GA
az webpubsub service permission grant	授予对连接的组权限。 如果操作失败，则引发错误。	分机	GA
az webpubsub service permission revoke	从连接撤消组权限。 如果操作失败，则引发错误。	扩展	GA
az webpubsub service user	用于管理 Webpubsub 服务用户的命令。	分机	GA
az webpubsub service user exist	检查是否存在任何为给定用户连接的客户端连接。	扩展	GA
az webpubsub service user send	向用户发送消息。 如果操作失败，则引发错误。	扩展	GA

az webpubsub service broadcast

将消息广播到中心。 如果操作失败，则引发错误。

az webpubsub service broadcast --hub-name
                               --payload
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

示例

将消息发送到中心

az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload

必需参数

--hub-name

要管理的中心。

--payload

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

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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 获取完整的调试日志。