az signalr key

Manage keys for Azure SignalR Service.

Commands

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

List the access keys for a SignalR Service.

az signalr key list --name
                    --resource-group
                    [--query-examples]
                    [--subscription]

Examples

Get the primary key for a SignalR Service.

az signalr key list -n MySignalR -g MyResourceGroup --query primaryKey -o tsv

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az signalr key renew

Regenerate the access key for a SignalR Service.

az signalr key renew --key-type {primary, secondary}
                     --name
                     --resource-group
                     [--subscription]

Examples

Renew the secondary key for a SignalR Service.

az signalr key renew -n MySignalR -g MyResourceGroup --key-type secondary

Required Parameters

--key-type

The name of access key to regenerate.

accepted values: primary, secondary
--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.