Share via

az eventhubs eventhub authorization-rule

  • Reference

Eventhub authorization rule.

Commands

Name Description Type Status
az eventhubs eventhub authorization-rule create

Create an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

 Core GA
az eventhubs eventhub authorization-rule delete

Delete an Event Hub AuthorizationRule.

 Core GA
az eventhubs eventhub authorization-rule keys

Authorization-rule keys.

 Core GA
az eventhubs eventhub authorization-rule keys list

Gets the ACS and SAS connection strings for the Event Hub.

 Core GA
az eventhubs eventhub authorization-rule keys renew

Regenerates the ACS and SAS connection strings for the Event Hub.

 Core GA
az eventhubs eventhub authorization-rule list

List the authorization rules for an Event Hub.

 Core GA
az eventhubs eventhub authorization-rule show

Get an AuthorizationRule for an Event Hub by rule name.

 Core GA
az eventhubs eventhub authorization-rule update

Update an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

 Core GA

az eventhubs eventhub authorization-rule create

Edit

Create an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

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

Examples

Creates Authorizationrule for the given Eventhub

az eventhub authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule --rights Listen

Required Parameters

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

The authorization rule name.

--eventhub-name

The Event Hub 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

--rights

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

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

Edit

Delete an Event Hub AuthorizationRule.

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

Examples

Deletes the Authorizationrule of Eventhub.

az eventhubs eventhub authorization-rule delete --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule

Optional Parameters

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

The authorization rule name.

--eventhub-name

The Event Hub 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.

--namespace-name

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

az eventhubs eventhub authorization-rule list

Edit

List the authorization rules for an Event Hub.

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

Examples

shows the list of Authorization-rules by Eventhub

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

Required Parameters

--eventhub-name

The Event Hub 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

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

--next-token

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

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 eventhubs eventhub authorization-rule show

Edit

Get an AuthorizationRule for an Event Hub by rule name.

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

Examples

shows the details of Authorizationrule

az eventhubs eventhub authorization-rule show --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule

Optional Parameters

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

The authorization rule name.

--eventhub-name

The Event Hub 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.

--namespace-name

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

az eventhubs eventhub authorization-rule update

Edit

Update an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

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

Examples

Update Eventhubs Authorization-Rule

az eventhubs eventhub authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule --rights Send

Optional Parameters

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

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

The authorization rule name.

--eventhub-name

The Event Hub name.

--force-string

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

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.

--namespace-name

The Namespace name.

--remove

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

--resource-group -g

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

--rights

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

--set

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

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