az webpubsub

命令

名称	说明	类型	Status
az webpubsub client	用于管理客户端连接的命令。	Extension	GA
az webpubsub client start	启动交互式客户端连接。	Extension	GA
az webpubsub create	创建 Webpubsub。	Extension	GA
az webpubsub custom-certificate	管理 WebPubSub 自定义证书。	Extension	GA
az webpubsub custom-certificate create	创建自定义 WebPubSub 服务的证书。	Extension	GA
az webpubsub custom-certificate delete	删除 WebPubSub 服务的自定义证书。	Extension	GA
az webpubsub custom-certificate list	列出 WebPubSub 服务的自定义证书。	Extension	GA
az webpubsub custom-certificate show	显示 WebPubSub 服务的自定义证书的详细信息。	Extension	GA
az webpubsub custom-domain	管理自定义域设置。	Extension	GA
az webpubsub custom-domain create	创建 WebPubSub 服务的自定义域。	Extension	GA
az webpubsub custom-domain delete	删除 WebPubSub 服务的自定义域。	Extension	GA
az webpubsub custom-domain list	列出 WebPubSub 服务的自定义域。	Extension	GA
az webpubsub custom-domain show	显示 WebPubSub 服务的自定义域的详细信息。	Extension	GA
az webpubsub delete	删除 Webpubsub。	Extension	GA
az webpubsub hub	用于管理 Webpubsub 中心设置的命令。	Extension	GA
az webpubsub hub create	在无服务器模式下为 WebPubSub 服务或 Web PubSub 创建用于 Socket.IO 的中心设置。	Extension	GA
az webpubsub hub delete	删除 WebPubSub 服务的中心设置。	Extension	GA
az webpubsub hub list	列出 WebPubSub 服务的所有中心设置。	Extension	GA
az webpubsub hub show	显示 WebPubSub 服务的中心设置。	Extension	GA
az webpubsub hub update	在无服务器模式下更新 WebPubSub 服务或用于 Socket.IO 的 Web PubSub 中心设置。	Extension	GA
az webpubsub identity	管理托管标识设置。	Extension	GA
az webpubsub identity assign	为 WebPubSub 服务分配托管标识。	Extension	GA
az webpubsub identity remove	删除 WebPubSub 服务的托管标识。	Extension	GA
az webpubsub identity show	显示 WebPubSub 服务的托管标识。	Extension	GA
az webpubsub key	用于管理 Webpubsub 密钥的命令。	Extension	GA
az webpubsub key regenerate	重新生成 WebPubSub 服务的密钥。	Extension	GA
az webpubsub key show	显示 WebPubSub 服务的串联字符串和密钥。	Extension	GA
az webpubsub list	列出 Webpubsub。	Extension	GA
az webpubsub list-skus	列出资源的所有可用 SKU。	Extension	GA
az webpubsub list-usage	按位置列出资源使用情况配额。	Extension	GA
az webpubsub network-rule	用于管理 Webpubsub 网络规则的命令。	Extension	GA
az webpubsub network-rule ip-rule	管理 WebPubSub 服务 IP 规则。	Extension	GA
az webpubsub network-rule ip-rule add	将 IP 规则添加到 WebPubSub 服务。	Extension	GA
az webpubsub network-rule ip-rule remove	从 WebPubSub 服务中删除 IP 规则。	Extension	GA
az webpubsub network-rule show	获取 WebPubSub 服务的网络访问控制。	Extension	GA
az webpubsub network-rule update	更新 WebPubSub 服务的网络访问控制。	Extension	GA
az webpubsub replica	管理副本设置。	Extension	GA
az webpubsub replica create	创建 Webpubsub 服务的副本。	Extension	GA
az webpubsub replica delete	删除 WebPubSub 服务的副本。	Extension	GA
az webpubsub replica list	列出 Webpubsub 服务的副本。	Extension	GA
az webpubsub replica restart	重启 WebPubSub 服务的副本。	Extension	GA
az webpubsub replica show	显示副本的详细信息。	Extension	GA
az webpubsub replica start	启动 WebPubSub 服务的副本。	Extension	GA
az webpubsub replica stop	停止 WebPubSub 服务的副本。	Extension	GA
az webpubsub replica update	更新 Webpubsub 服务的副本。	Extension	GA
az webpubsub restart	重启 Webpubsub。	Extension	GA
az webpubsub service	用于管理 Webpubsub 服务的命令。	Extension	GA
az webpubsub service broadcast	将消息广播到中心。 如果作失败，则引发错误。	Extension	GA
az webpubsub service connection	用于管理 Webpubsub 服务连接的命令。	Extension	GA
az webpubsub service connection close	关闭特定的客户端连接。 如果作失败，则引发错误。	Extension	GA
az webpubsub service connection exist	检查客户端连接是否存在。	Extension	GA
az webpubsub service connection send	向连接发送消息。 如果作失败，则引发错误。	Extension	GA
az webpubsub service group	用于管理 Webpubsub 服务组的命令。	Extension	GA
az webpubsub service group add-connection	将连接添加到组。 如果作失败，则引发错误。	Extension	GA
az webpubsub service group add-user	将用户添加到组。 如果作失败，则引发错误。	Extension	GA
az webpubsub service group remove-connection	从组中删除连接。 如果作失败，则引发错误。	Extension	GA
az webpubsub service group remove-user	从组中删除用户。 如果作失败，则引发错误。	Extension	GA
az webpubsub service group send	将消息发送到组。 如果作失败，则引发错误。	Extension	GA
az webpubsub service permission	用于管理 Webpubsub 服务权限的命令。	Extension	GA
az webpubsub service permission check	检查连接是否具有对指定组的权限。	Extension	GA
az webpubsub service permission grant	授予对连接的组权限。 如果作失败，则引发错误。	Extension	GA
az webpubsub service permission revoke	从连接撤消组权限。 如果作失败，则引发错误。	Extension	GA
az webpubsub service user	用于管理 Webpubsub 服务用户的命令。	Extension	GA
az webpubsub service user exist	检查是否为给定用户连接了任何客户端连接。	Extension	GA
az webpubsub service user send	向用户发送消息。 如果作失败，则引发错误。	Extension	GA
az webpubsub show	显示 Webpubsub 的详细信息。	Extension	GA
az webpubsub start	启动 Webpubsub。	Extension	GA
az webpubsub stop	停止 Webpubsub。	Extension	GA
az webpubsub update	更新 Webpubsub。	Extension	GA

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--service-mode]
                    [--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

使用高级 SKU 和单元 1 在无服务器模式下创建用于 Socket.IO 的 Web PubSub

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

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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 webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

az webpubsub list [--resource-group]

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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 webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

az webpubsub list-usage --location

必需参数

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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 webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

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

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

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

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

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

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False

az webpubsub update [--add]
                    [--client-cert-enabled {false, true}]
                    [--disable-local-auth {false, true}]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--region-endpoint-enabled {false, true}]
                    [--remove]
                    [--resource-group]
                    [--service-mode]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

示例

将 WebPubSub 服务更新为单元 10。

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

将用于 Socket.IO 的 Web PubSub 更新为无服务器模式。

az webpubsub update -n MyWebPubSub -g MyResourceGroup --service-mode Serverless

启用或禁用 WebPubSub 服务的客户端证书身份验证

az webpubsub update -n MyWebPubSub -g MyResourceGroup --client-cert-enabled true

启用或禁用 WebPubSub 服务的本地身份验证

az webpubsub update -n MyWebPubSub -g MyResourceGroup --disable-local-auth true

启用或禁用 WebPubSub 服务的区域终结点

az webpubsub update -n MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--verbose

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

属性	值
默认值:	False