az signalr

Manage Azure SignalR Service.

Commands

az signalr cors Manage CORS for Azure SignalR Service.
az signalr cors add Add allowed origins to a SignalR Service.
az signalr cors list List allowed origins of a SignalR Service.
az signalr cors remove Remove allowed origins from a SignalR Service.
az signalr create Creates a SignalR Service.
az signalr delete Deletes a SignalR Service.
az signalr key Manage keys for Azure SignalR Service.
az signalr key list List the access keys for a SignalR Service.
az signalr key renew Regenerate the access key for a SignalR Service.
az signalr list Lists all the SignalR Service under the current subscription.
az signalr restart Restart an existing SignalR Service.
az signalr show Get the details of a SignalR Service.
az signalr update Update an existing SignalR Service.

az signalr create

Creates a SignalR Service.

az signalr create --name
--resource-group
--sku
[--allowed-origins]
[--location]
[--service-mode {Classic, Default, Serverless}]
[--subscription]
[--tags]
[--unit-count]

Examples

Create a SignalR Service with the Standard SKU and serverless mode.

az signalr create -n MySignalR -g MyResourceGroup --sku Standard_S1 --unit-count 1 --service-mode Serverless

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. E.g. Standard_S1.

Optional Parameters

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

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

accepted values: Classic, Default, Serverless
default value: Default
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--unit-count

The number of signalr service unit count.

default value: 1

az signalr delete

Deletes a SignalR Service.

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

Examples

Delete a SignalR Service.

az signalr delete -n MySignalR -g MyResourceGroup

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

Optional Parameters

--subscription

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

az signalr list

Lists all the SignalR Service under the current subscription.

az signalr list [--resource-group]
[--subscription]

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

--resource-group -g

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

--subscription

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

az signalr restart

Restart an existing SignalR Service.

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

Examples

Restart a SignalR Service instance.

az signalr restart -n MySignalR -g MyResourceGroup

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

Optional Parameters

--subscription

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

az signalr show

Get the details of a SignalR Service.

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

Examples

Get the sku for a SignalR Service.

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

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

Optional Parameters

--subscription

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

az signalr update

Update an existing SignalR Service.

az signalr update --name
--resource-group
[--add]
[--allowed-origins]
[--force-string]
[--remove]
[--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

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

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

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

--force-string

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

--remove

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

--service-mode

The service mode which signalr service will be working on.

accepted values: Classic, Default, Serverless
--set

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

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--unit-count

The number of signalr service unit count.

default value: 1