Share via

az webpubsub replica

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az webpubsub replica command. Learn more about extensions.

Manage replica settings.

Commands

Name Description Type Status
az webpubsub replica create

Create a replica of Webpubsub Service.

 Extension GA
az webpubsub replica delete

Delete a replica of WebPubSub Service.

 Extension GA
az webpubsub replica list

List replicas of Webpubsub Service.

 Extension GA
az webpubsub replica restart

Restart a replica of WebPubSub Service.

 Extension GA
az webpubsub replica show

Show the details of a replica.

 Extension GA
az webpubsub replica start

Start a replica of WebPubSub Service.

 Extension GA
az webpubsub replica stop

Stop a replica of WebPubSub Service.

 Extension GA
az webpubsub replica update

Update a replica of Webpubsub Service.

 Extension GA

az webpubsub replica create

Create a replica of Webpubsub Service.

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

Examples

Get the detail of a replica

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

Required Parameters

--name -n

Name of the webpubsub.

--replica-name

Name of the replica.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The sku name of the replica. Currently allowed values: Premium_P1.

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--unit-count

The number of webpubsub service unit count.

Property Value
Default value: 1
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica delete

Delete a replica of WebPubSub Service.

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

Examples

Delete a replica

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--replica-name

Name of the replica.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica list

List replicas of Webpubsub Service.

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

Examples

Get the detail of a replica

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

Required Parameters

--name -n

Name of the webpubsub.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica restart

Restart a replica of WebPubSub Service.

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

Examples

Restart a replica

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--replica-name

Name of the replica.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica show

Show the details of a replica.

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

Examples

Get the detail of a replica

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--replica-name

Name of the replica.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica start

Start a replica of WebPubSub Service.

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

Examples

Start a replica

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--replica-name

Name of the replica.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica stop

Stop a replica of WebPubSub Service.

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

Examples

Stop a replica

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

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--replica-name

Name of the replica.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub replica update

Update a replica of Webpubsub Service.

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

Examples

Enable or disable region endpoint for the replica of WebPubSub Service

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

Update the unit count of the replica of WebPubSub Service

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

Required Parameters

--name -n

Name of the webpubsub.

--replica-name

Name of the replica.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Default value: False
--region-endpoint-enabled

Enable or disable region endpoint for a WebPubSub Service.

Property Value
Accepted values: false, true
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--unit-count

The number of webpubsub service unit count.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False