Share via

az servicebus topic authorization-rule

Servicebus topic authorization-rule.

Commands

Name Description Type Status
az servicebus topic authorization-rule create

Create an authorization rule for the specified topic.

 Core GA
az servicebus topic authorization-rule delete

Delete a topic authorization rule.

 Core GA
az servicebus topic authorization-rule keys

Servicebus topic authorization-rule keys.

 Core GA
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 list

List authorization rules for a topic.

 Core GA
az servicebus topic authorization-rule show

Get the specified authorization rule.

 Core GA
az servicebus topic authorization-rule update

Update an authorization rule for the specified topic.

 Core GA

az servicebus topic authorization-rule create

Edit

Create an authorization rule for the specified topic.

az servicebus topic authorization-rule create --authorization-rule-name --name
                                              --namespace-name
                                              --resource-group
                                              --topic-name
                                              [--rights]

Examples

Create Authorization Rule for given Service Bus Topic

az servicebus topic authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name myauthorule --rights Send Listen

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.

Optional Parameters

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

--rights

The rights associated with the rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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.

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

Edit

Delete a topic authorization rule.

az servicebus topic authorization-rule delete [--authorization-rule-name --name]
                                              [--ids]
                                              [--namespace-name]
                                              [--resource-group]
                                              [--subscription]
                                              [--topic-name]

Examples

Deletes the Authorization Rule of Service Bus Topic.

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

Optional Parameters

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

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

The authorization rule name.

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

az servicebus topic authorization-rule list

Edit

List authorization rules for a topic.

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

Examples

shows list of Authorization Rule by Service Bus Topic

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

Required Parameters

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

Edit

Get the specified authorization rule.

az servicebus topic authorization-rule show [--authorization-rule-name --name]
                                            [--ids]
                                            [--namespace-name]
                                            [--resource-group]
                                            [--subscription]
                                            [--topic-name]

Examples

Shows the details of Authorization Rule for given Service Bus Topic

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

Optional Parameters

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

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

The authorization rule name.

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

az servicebus topic authorization-rule update

Edit

Update an authorization rule for the specified topic.

az servicebus topic authorization-rule update [--add]
                                              [--authorization-rule-name --name]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ids]
                                              [--namespace-name]
                                              [--remove]
                                              [--resource-group]
                                              [--rights]
                                              [--set]
                                              [--subscription]
                                              [--topic-name]

Examples

Create Authorization Rule for given Service Bus Topic.

az servicebus topic authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name myauthorule --rights Send

Optional Parameters

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

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

Property Value
Parameter group: Generic Update Arguments
--authorization-rule-name --name -n

The authorization rule name.

Property Value
Parameter group: Resource Id Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update 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
--rights

The rights associated with the rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--set

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

Property Value
Parameter group: Generic Update 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