az webpubsub

预览
参考

注释

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

此命令组处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

用于管理 Webpubsub 的命令。

命令

名称	说明	类型	Status
az webpubsub create	创建 Webpubsub。	扩展	预览
az webpubsub delete	删除 Webpubsub。	扩展	预览
az webpubsub event-handler	用于管理 Webpubsub 事件处理程序设置的命令。	扩展	预览
az webpubsub event-handler clear	清除 WebPubSub 服务的事件处理程序设置。	扩展	预览
az webpubsub event-handler hub	用于管理 Webpubsub 中心设置的命令。	扩展	预览
az webpubsub event-handler hub remove	删除中心的事件处理程序设置。	扩展	预览
az webpubsub event-handler hub update	更新中心的事件处理程序设置。	扩展	预览
az webpubsub event-handler show	显示 WebPubSub 服务的事件处理程序设置。	扩展	预览
az webpubsub event-handler update	更新 WebPubSub 服务的事件处理程序设置。	扩展	预览
az webpubsub key	用于管理 Webpubsub 密钥的命令。	扩展	预览
az webpubsub key regenerate	重新生成 WebPubSub 服务的密钥。	扩展	预览
az webpubsub key show	显示 WebPubSub 服务的串联字符串和密钥。	扩展	预览
az webpubsub list	列出 Webpubsub。	扩展	预览
az webpubsub network-rule	用于管理 Webpubsub 网络规则的命令。	扩展	预览
az webpubsub network-rule show	获取 WebPubSub 服务的网络访问控制。	扩展	预览
az webpubsub network-rule update	更新 WebPubSub 服务的网络访问控制。	扩展	预览
az webpubsub restart	重启 Webpubsub。	扩展	预览
az webpubsub show	显示 Webpubsub 的详细信息。	扩展	预览
az webpubsub update	更新 Webpubsub。	扩展	预览

az webpubsub create

预览

命令组“webpubsub”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

创建 Webpubsub。

az webpubsub create --name
                    --resource-group
                    --sku {Free_F1, Standard_S1}
                    [--___location]
                    [--tags]
                    [--unit-count]

示例

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

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

必需参数

--name -n

Webpubsub 的名称。

--resource-group -g

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

--sku

signalr 服务的 SKU 名称。

接受的值: Free_F1, Standard_S1

可选参数

--___location -l

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

--tags

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

--unit-count

信号器服务单位计数。

默认值: 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”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

删除 Webpubsub。

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

可选参数

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

预览

命令组“webpubsub”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

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

预览

命令组“webpubsub”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

重启 Webpubsub。

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

可选参数

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

预览

命令组“webpubsub”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

显示 Webpubsub 的详细信息。

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

可选参数

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

预览

命令组“webpubsub”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

更新 Webpubsub。

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku {Free_F1, Standard_S1}]
                    [--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（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource 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

signalr 服务的 SKU 名称。

接受的值: Free_F1, Standard_S1

--subscription

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

--tags

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

--unit-count

信号器服务单位计数。

全局参数

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