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

az webpubsub replica

Note

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

管理副本设置。

命令

名称	说明	类型	Status
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 replica create

创建 Webpubsub 服务的副本。

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

示例

获取副本的详细信息

az webpubsub replica create --sku Premium_P1 -l eastus --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

必需参数

--name -n

Webpubsub 的名称。

--replica-name

副本的名称。

--resource-group -g

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

--sku

副本的 SKU 名称。当前允许的值：Premium_P1。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--location -l

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

--tags

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

--unit-count

webpubsub 服务单位计数。

属性	值
默认值:	1

全局参数

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

删除 WebPubSub 服务的副本。

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

示例

删除副本

az webpubsub replica delete --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性	值
参数组:	Resource Id Arguments

--name -n

Webpubsub 的名称。

属性	值
参数组:	Resource Id Arguments

--replica-name

副本的名称。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

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

列出 Webpubsub 服务的副本。

az webpubsub replica list --name
                          --resource-group

示例

获取副本的详细信息

az webpubsub replica list --name MyWebPubSub -g MyResourceGroup -o table

必需参数

--name -n

Webpubsub 的名称。

--resource-group -g

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

全局参数

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

重启 WebPubSub 服务的副本。

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

示例

重启副本

az webpubsub replica restart --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性	值
参数组:	Resource Id Arguments

--name -n

Webpubsub 的名称。

属性	值
参数组:	Resource Id Arguments

--replica-name

副本的名称。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

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

显示副本的详细信息。

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

示例

获取副本的详细信息

az webpubsub replica show --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性	值
参数组:	Resource Id Arguments

--name -n

Webpubsub 的名称。

属性	值
参数组:	Resource Id Arguments

--replica-name

副本的名称。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

--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 replica start

启动 WebPubSub 服务的副本。

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

示例

启动副本

az webpubsub replica start --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性	值
参数组:	Resource Id Arguments

--name -n

Webpubsub 的名称。

属性	值
参数组:	Resource Id Arguments

--replica-name

副本的名称。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

--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 replica stop

停止 WebPubSub 服务的副本。

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

示例

停止副本

az webpubsub replica stop --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

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

属性	值
参数组:	Resource Id Arguments

--name -n

Webpubsub 的名称。

属性	值
参数组:	Resource Id Arguments

--replica-name

副本的名称。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

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

更新 Webpubsub 服务的副本。

az webpubsub replica update --name
                            --replica-name
                            --resource-group
                            [--add]
                            [--force-string]
                            [--region-endpoint-enabled {false, true}]
                            [--remove]
                            [--set]
                            [--unit-count]

示例

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

az webpubsub replica update --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true

更新 WebPubSub 服务副本的单位计数

az webpubsub replica update --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup --unit-count 2

必需参数

--name -n

Webpubsub 的名称。

--replica-name

副本的名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--add

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--force-string

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

属性	值
参数组:	Generic Update Arguments
默认值:	False

--region-endpoint-enabled

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

属性	值
接受的值:	false, true

--remove

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--set

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--unit-count

webpubsub 服务单位计数。

全局参数

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

反馈

此页面是否有帮助？