Share via

az servicebus queue authorization-rule keys

  • Reference

Servicebus queue authorization-rule keys.

Commands

Name Description Type Status
az servicebus queue authorization-rule keys list

Primary and secondary connection strings to the queue.

 Core GA
az servicebus queue authorization-rule keys renew

Regenerates the primary or secondary connection strings to the queue.

 Core GA

az servicebus queue authorization-rule keys list

Edit

Primary and secondary connection strings to the queue.

az servicebus queue authorization-rule keys list --authorization-rule-name
                                                 --namespace-name
                                                 --queue-name
                                                 --resource-group

Examples

List the keys and connection strings of Authorization Rule for the given Service Bus Queue

az servicebus queue authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --queue-name myqueue --name myauthorule

Required Parameters

--authorization-rule-name --name -n

The authorization rule name.

--namespace-name

The namespace name.

--queue-name

The queue name.

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

--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 servicebus queue authorization-rule keys renew

Edit

Regenerates the primary or secondary connection strings to the queue.

az servicebus queue authorization-rule keys renew --key {PrimaryKey, SecondaryKey}
                                                  [--authorization-rule-name]
                                                  [--ids]
                                                  [--key-value]
                                                  [--namespace-name]
                                                  [--queue-name]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Regenerate keys of Authorization Rule for Service Bus Queue

az servicebus queue authorization-rule keys renew --resource-group myresourcegroup --namespace-name mynamespace --queue-name myqueue --name myauthorule --key PrimaryKey

Required Parameters

--key

The access key to regenerate.

Accepted values: PrimaryKey, SecondaryKey

Optional Parameters

--authorization-rule-name --name -n

The authorization rule name.

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

--key-value

Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType.

--namespace-name

The namespace name.

--queue-name

The queue name.

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

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.