Share via

az eventhubs namespace authorization-rule

Eventhub namespace authorization-rule.

Commands

Name Description Type Status
az eventhubs namespace authorization-rule create

Create an AuthorizationRule for a Namespace.

 Core GA
az eventhubs namespace authorization-rule delete

Delete an AuthorizationRule for a Namespace.

 Core GA
az eventhubs namespace authorization-rule keys

Authorization-rule keys.

 Core GA
az eventhubs namespace authorization-rule keys list

Gets the primary and secondary connection strings for the Namespace.

 Core GA
az eventhubs namespace authorization-rule keys renew

Regenerates the primary or secondary connection strings for the specified Namespace.

 Core GA
az eventhubs namespace authorization-rule list

List a list of authorization rules for a Namespace.

 Core GA
az eventhubs namespace authorization-rule show

Get an AuthorizationRule for a Namespace by rule name.

 Core GA
az eventhubs namespace authorization-rule update

Update an AuthorizationRule for a Namespace.

 Core GA

az eventhubs namespace authorization-rule create

Edit

Create an AuthorizationRule for a Namespace.

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

Examples

Creates Authorizationrule

az eventhubs namespace authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --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>.

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 eventhubs namespace authorization-rule delete

Edit

Delete an AuthorizationRule for a Namespace.

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

Examples

Deletes the Authorizationrule of the namespace

az eventhubs namespace authorization-rule delete --resource-group myresourcegroup --namespace-name mynamespace --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
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 eventhubs namespace authorization-rule list

Edit

List a list of authorization rules for a Namespace.

az eventhubs namespace authorization-rule list --namespace-name
                                               --resource-group
                                               [--max-items]
                                               [--next-token]

Examples

Shows the list of Authorizationrule by Namespace

az eventhubs namespace authorization-rule list --resource-group myresourcegroup --namespace-name mynamespace

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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 eventhubs namespace authorization-rule show

Edit

Get an AuthorizationRule for a Namespace by rule name.

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

Examples

Shows the details of Authorizationrule

az eventhubs namespace authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --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.

--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
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 eventhubs namespace authorization-rule update

Edit

Update an AuthorizationRule for a Namespace.

az eventhubs namespace 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]

Examples

Updates Authorizationrule

az eventhubs namespace authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --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
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