az signalr

Manage Azure SignalR Service.

Commands

Name	Description	Type	Status
az signalr cors	Manage CORS for Azure SignalR Service.	Core	GA
az signalr cors add	Add allowed origins to a SignalR Service.	Core	GA
az signalr cors list	List allowed origins of a SignalR Service.	Core	GA
az signalr cors remove	Remove allowed origins from a SignalR Service.	Core	GA
az signalr cors update	Update allowed origins to a SignalR Service.	Core	GA
az signalr create	Creates a SignalR Service.	Core	GA
az signalr custom-certificate	Manage custom certificate settings.	Core	GA
az signalr custom-certificate create	Create a custom certificate of SignalR Service.	Core	GA
az signalr custom-certificate delete	Delete a custom certificate of SignalR Service.	Core	GA
az signalr custom-certificate list	List custom certificate of SignalR Service.	Core	GA
az signalr custom-certificate show	Show the detail of a custom certificate of SignalR Service.	Core	GA
az signalr custom-certificate update	Update a custom certificate of SignalR Service.	Core	GA
az signalr custom-domain	Manage custom domain settings.	Core	GA
az signalr custom-domain create	Create a custom domain of SignalR Service.	Core	GA
az signalr custom-domain delete	Delete a custom domain of SignalR Service.	Core	GA
az signalr custom-domain list	List custom domains of SignalR Service.	Core	GA
az signalr custom-domain show	Show the detail of a custom domain of SignalR Service.	Core	GA
az signalr custom-domain update	Update a custom domain of SignalR Service.	Core	GA
az signalr delete	Deletes a SignalR Service.	Core	GA
az signalr identity	Manage managed identity settings.	Core	GA
az signalr identity assign	Assign managed identity for SignalR Service.	Core	GA
az signalr identity remove	Remove managed identity for SignalR Service.	Core	GA
az signalr identity show	Show managed identity for SignalR Service.	Core	GA
az signalr key	Manage keys for Azure SignalR Service.	Core	GA
az signalr key list	List the access keys for a SignalR Service.	Core	GA
az signalr key renew	Regenerate the access key for a SignalR Service.	Core	GA
az signalr list	Lists all the SignalR Service under the current subscription.	Core	GA
az signalr network-rule	Manage network rules.	Core	GA
az signalr network-rule ip-rule	Manage SignalR Service IP rules.	Core	GA
az signalr network-rule ip-rule add	Add IP rule to SignalR Service.	Core	GA
az signalr network-rule ip-rule remove	Remove IP rule from SignalR Service.	Core	GA
az signalr network-rule list	Get the Network access control of SignalR Service.	Core	GA
az signalr network-rule update	Update the Network access control of SignalR Service.	Core	GA
az signalr replica	Manage replica settings.	Core	GA
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 restart	Restart an existing SignalR Service.	Core	GA
az signalr show	Get the details of a SignalR Service.	Core	GA
az signalr start	Start an existing SignalR Service.	Core	GA
az signalr stop	Stop an existing SignalR Service.	Core	GA
az signalr update	Update an existing SignalR Service.	Core	GA
az signalr upstream	Manage upstream settings.	Core	GA
az signalr upstream clear	Clear upstream settings of an existing SignalR Service.	Core	GA
az signalr upstream list	List upstream settings of an existing SignalR Service.	Core	GA
az signalr upstream update	Update order sensitive upstream settings for an existing SignalR Service.	Core	GA

az signalr create

Edit

Creates a SignalR Service.

az signalr create --name
                  --resource-group
                  --sku
                  [--allowed-origins]
                  [--default-action {Allow, Deny}]
                  [--enable-message-logs {false, true}]
                  [--location]
                  [--service-mode {Classic, Default, Serverless}]
                  [--tags]
                  [--unit-count]

Examples

Create a SignalR Service with the Premium SKU and default mode

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1

Create a SignalR Service with the Premium SKU and serverless mode and enable messaging logs.

az signalr create -n MySignalR -g MyResourceGroup --sku Premium_P1 --unit-count 1 --service-mode Serverless --enable-message-logs True

Required Parameters

--name -n

Name of signalr service.

--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 signalr service. Allowed values: Premium_P1, Standard_S1, Free_F1.

Optional Parameters

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

--allowed-origins -a

Space separated origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). To allow all, use "*".

--default-action

Default action to apply when no rule matches.

Property	Value
Parameter group:	Network Rule Arguments
Default value:	Allow
Accepted values:	Allow, Deny

--enable-message-logs

The switch for messaging logs which signalr service will generate or not.

Property	Value
Default value:	False
Accepted values:	false, true

--location -l

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

--service-mode

The service mode which signalr service will be working on.

Property	Value
Default value:	Default
Accepted values:	Classic, Default, Serverless

--tags

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

--unit-count

The number of signalr 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 signalr delete

Edit

Deletes a SignalR Service.

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

Examples

Delete a SignalR Service.

az signalr delete -n MySignalR -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 signalr service.

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

Edit

Lists all the SignalR Service under the current subscription.

az signalr list [--resource-group]

Examples

List SignalR Service and show the results in a table.

az signalr list -o table

List SignalR Service in a resource group and show the results in a table.

az signalr list -g MySignalR -o table

Optional Parameters

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

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

Edit

Restart an existing SignalR Service.

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

Examples

Restart a SignalR Service instance.

az signalr restart -n MySignalR -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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of signalr service.

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

Edit

Get the details of a SignalR Service.

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

Examples

Get the sku for a SignalR Service.

az signalr show -n MySignalR -g MyResourceGroup --query sku

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of signalr service.

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

Edit

Start an existing SignalR Service.

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

Examples

Start a SignalR Service instance.

az signalr start -n MySignalR -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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of signalr service.

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

Edit

Stop an existing SignalR Service.

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

Examples

Stop a SignalR Service instance.

az signalr stop -n MySignalR -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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of signalr service.

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

Edit

Update an existing SignalR Service.

az signalr update [--add]
                  [--allowed-origins]
                  [--client-cert-enabled {false, true}]
                  [--default-action {Allow, Deny}]
                  [--disable-local-auth {false, true}]
                  [--enable-message-logs {false, true}]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--region-endpoint-enabled {false, true}]
                  [--remove]
                  [--resource-group]
                  [--service-mode {Classic, Default, Serverless}]
                  [--set]
                  [--sku]
                  [--subscription]
                  [--tags]
                  [--unit-count]

Examples

Update unit count to scale the service.

az signalr update -n MySignalR -g MyResourceGroup --sku Standard_S1 --unit-count 50

Update service mode.

az signalr update -n MySignalR -g MyResourceGroup --service-mode Serverless

Update for enabling messaging logs in the service.

az signalr update -n MySignalR -g MyResourceGroup --enable-message-logs True

Enable or disable client certificate authentication for a SignalR Service

az signalr update -n MySignalR -g MyResourceGroup --client-cert-enabled False

Enable or disable local auth for a SignalR Service

az signalr update -n MySignalR -g MyResourceGroup --disable-local-auth True

Enable or disable region endpoint for a SignalR Service

az signalr update -n MySignalR -g MyResourceGroup --region-endpoint-enabled False

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:	[]

--allowed-origins -a

Space separated origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). To allow all, use "*".

--client-cert-enabled

Enable or disable client certificate authentication for a SignalR Service.

Property	Value
Accepted values:	false, true

--default-action

Default action to apply when no rule matches.

Property	Value
Parameter group:	Network Rule Arguments
Accepted values:	Allow, Deny

--disable-local-auth

Enable or disable local auth for a SignalR Service.

Property	Value
Accepted values:	false, true

--enable-message-logs

The switch for messaging logs which signalr service will generate or not.

Property	Value
Accepted values:	false, true

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of signalr service.

Property	Value
Parameter group:	Resource Id Arguments

--region-endpoint-enabled

Enable or disable region endpoint for a SignalR 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:	[]

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

--service-mode

The service mode which signalr service will be working on.

Property	Value
Accepted values:	Classic, Default, Serverless

--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:	[]

--sku

The sku name of the signalr service. E.g. Standard_S1.

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

--tags

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

--unit-count

The number of signalr 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.

--verbose

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

Property	Value
Default value:	False

Share via

az signalr

Commands

az signalr create

Examples

Required Parameters

Optional Parameters

az signalr delete

Examples

Optional Parameters

az signalr list

Examples

Optional Parameters

az signalr restart

Examples

Optional Parameters

az signalr show

Examples

Optional Parameters

az signalr start

Examples

Optional Parameters

az signalr stop

Examples

Optional Parameters

az signalr update

Examples

Optional Parameters

Feedback