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

az webpubsub

注意

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

用于管理 Webpubsub 的命令。

命令

名称	说明	类型	状态
az webpubsub client	用于管理客户端连接的命令。	扩展	GA
az webpubsub client start	启动交互式客户端连接。	扩展	GA
az webpubsub create	创建 Webpubsub。	扩展	GA
az webpubsub delete	删除 Webpubsub。	扩展	GA
az webpubsub hub	用于管理 Webpubsub 中心设置的命令。	扩展	GA
az webpubsub hub create	创建 WebPubSub 服务的中心设置。	扩展	GA
az webpubsub hub delete	删除 WebPubSub 服务的中心设置。	扩展	GA
az webpubsub hub list	列出 WebPubSub 服务的所有中心设置。	扩展	GA
az webpubsub hub show	显示 WebPubSub 服务的中心设置。	扩展	GA
az webpubsub hub update	更新 WebPubSub 服务的中心设置。	扩展	GA
az webpubsub key	用于管理 Webpubsub 密钥的命令。	扩展	GA
az webpubsub key regenerate	重新生成 WebPubSub 服务的密钥。	扩展	GA
az webpubsub key show	显示 WebPubSub 服务的串联字符串和密钥。	扩展	GA
az webpubsub list	列出 Webpubsub。	扩展	GA
az webpubsub list-skus	列出资源的所有可用 SKU。	扩展	GA
az webpubsub list-usage	按位置列出资源使用情况配额。	扩展	GA
az webpubsub network-rule	用于管理 Webpubsub 网络规则的命令。	扩展	GA
az webpubsub network-rule show	获取 WebPubSub 服务的网络访问控制。	扩展	GA
az webpubsub network-rule update	更新 WebPubSub 服务的网络访问控制。	扩展	GA
az webpubsub replica	管理副本 (replica)设置。	扩展	GA
az webpubsub replica create	创建 Webpubsub 服务的副本 (replica)。	扩展	GA
az webpubsub replica delete	删除 WebPubSub 服务的副本 (replica)。	扩展	GA
az webpubsub replica list	列出 Webpubsub 服务的副本 (replica)。	扩展	GA
az webpubsub replica show	显示副本 (replica)的详细信息。	扩展	GA
az webpubsub restart	重启 Webpubsub。	扩展	GA
az webpubsub service	用于管理 Webpubsub 服务的命令。	扩展	GA
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 show	显示 Webpubsub 的详细信息。	扩展	GA
az webpubsub update	更新 Webpubsub。	扩展	GA

az webpubsub create

创建 Webpubsub。

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--tags]
                    [--unit-count]

示例

使用标准 SKU 和单元 2 创建 WebPubSub 服务。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

使用 高级版 SKU 和单元 1 创建用于 Socket.IO 的 Web PubSub。

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

必需参数

--name -n

Webpubsub 的名称。

--resource-group -g

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

--sku

Webpubsub 服务的 SKU 名称。 允许的值：Free_F1、Standard_S1、高级版_P1。

可选参数

--kind

Webpubsub 服务的种类。 允许的值：WebPubSub、SocketIO。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--unit-count

webpubsub 服务单位计数。

默认值: 1

全局参数

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

删除 Webpubsub。

az webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

可选参数

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

az webpubsub list

列出 Webpubsub。

az webpubsub 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 webpubsub list-skus

列出资源的所有可用 SKU。

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

可选参数

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

az webpubsub list-usage

按位置列出资源使用情况配额。

az webpubsub list-usage --location

必需参数

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

全局参数

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

重启 Webpubsub。

az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

可选参数

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

az webpubsub show

显示 Webpubsub 的详细信息。

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

可选参数

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

az webpubsub update

更新 Webpubsub。

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

示例

将 WebPubSub 服务更新为单元 10。

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

可选参数

--add

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

默认值: []

--force-string

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

默认值: False

--ids

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

--name -n

Webpubsub 的名称。

--remove

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

默认值: []

--resource-group -g

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

--set

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

默认值: []

--sku

Webpubsub 服务的 SKU 名称。 允许的值：Free_F1、Standard_S1、高级版_P1。

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--unit-count

webpubsub 服务单位计数。

全局参数

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