Share via

az signalr key

Manage keys for Azure SignalR Service.

Commands

Name Description Type Status
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 key list

Edit

List the access keys for a SignalR Service.

az signalr key list --name
                    --resource-group

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

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

Edit

Regenerate the access key for a SignalR Service.

az signalr key renew --key-type {primary, secondary}
                     [--acquire-policy-token]
                     [--change-reference]
                     [--ids]
                     [--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.

Property Value
Accepted values: primary, secondary

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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