Share via

az servicebus topic authorization-rule keys

Servicebus topic authorization-rule keys.

Commands

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

Gets the primary and secondary connection strings for the topic.

 Core GA
az servicebus topic authorization-rule keys renew

Regenerates primary or secondary connection strings for the topic.

 Core GA

az servicebus topic authorization-rule keys list

Edit

Gets the primary and secondary connection strings for the topic.

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

Examples

List the keys and connection strings of Authorization Rule for Service Bus Topic.

az servicebus topic authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name myauthorule

Required Parameters

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

The authorization rule name.

--namespace-name

The namespace name.

--resource-group -g

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

--topic-name

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

Edit

Regenerates primary or secondary connection strings for the topic.

az servicebus topic authorization-rule keys renew --key {PrimaryKey, SecondaryKey}
                                                  [--acquire-policy-token]
                                                  [--authorization-rule-name --name]
                                                  [--change-reference]
                                                  [--ids]
                                                  [--key-value]
                                                  [--namespace-name]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--topic-name]

Examples

Regenerate key of Service Bus Topic.

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

Required Parameters

--key

The access key to regenerate.

Property Value
Parameter group: Parameters Arguments
Accepted values: PrimaryKey, SecondaryKey

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
--authorization-rule-name --name -n

The authorization rule name.

Property Value
Parameter group: Resource Id 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
--key-value

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

Property Value
Parameter group: Parameters Arguments
--namespace-name

The namespace name.

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

The topic name.

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