Share via

az signalr replica

  • Reference

Manage replica settings.

Commands

Name Description Type Status
az signalr replica create

Create a replica of SignalR Service.

 Core GA
az signalr replica delete

Delete a replica of SignalR Service.

 Core GA
az signalr replica list

List replicas of SignalR Service.

 Core GA
az signalr replica restart

Restart a replica of SignalR Service.

 Core GA
az signalr replica show

Show the details of a replica.

 Core GA
az signalr replica start

Start a replica of SignalR Service.

 Core GA
az signalr replica stop

Stop a replica of SignalR Service.

 Core GA
az signalr replica update

Update a replica of SignalR Service.

 Core GA

az signalr replica create

Edit

Create a replica of SignalR Service.

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

Examples

Get the detail of a replica

az signalr replica create --sku Premium_P1 -l eastus --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Required Parameters

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

--signalr-name

Name of the SignalR.

--sku

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

Optional Parameters

--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 signalr service unit count.

Default value: 1
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica delete

Edit

Delete a replica of SignalR Service.

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

Examples

Delete a replica

az signalr replica delete --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Optional Parameters

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

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

--signalr-name

Name of the SignalR.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica list

Edit

List replicas of SignalR Service.

az signalr replica list --resource-group
                        --signalr-name

Examples

Get the detail of a replica

az signalr replica list --signalr-name MySignalR -g MyResourceGroup -o table

Required Parameters

--resource-group -g

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

--signalr-name

Name of the SignalR.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica restart

Edit

Restart a replica of SignalR Service.

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

Examples

Restart a replica

az signalr replica restart --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Optional Parameters

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

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

--signalr-name

Name of the SignalR.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica show

Edit

Show the details of a replica.

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

Examples

Get the detail of a replica

az signalr replica show --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Optional Parameters

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

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

--signalr-name

Name of the SignalR.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica start

Edit

Start a replica of SignalR Service.

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

Examples

Start a replica

az signalr replica start --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Optional Parameters

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

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

--signalr-name

Name of the SignalR.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica stop

Edit

Stop a replica of SignalR Service.

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

Examples

Stop a replica

az signalr replica stop --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup

Optional Parameters

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

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

--signalr-name

Name of the SignalR.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az signalr replica update

Edit

Update a replica of SignalR Service.

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

Examples

Enable or disable region endpoint for the replica of SignalR Service

az signalr replica update --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup --region-endpoint-enabled true

Update the unit count of the replica of SignalR Service

az signalr replica update --replica-name MyReplica --signalr-name MySignalR -g MyResourceGroup --unit-count 2

Required Parameters

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

--signalr-name

Name of the SignalR.

Optional Parameters

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

Default value: []
--force-string

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

Default value: False
--region-endpoint-enabled

Enable or disable region endpoint for a SignalR Service.

Accepted values: false, true
--remove

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

Default value: []
--set

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

Default value: []
--unit-count

The number of signalr service unit count.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.