az eventhubs eventhub authorization-rule keys

Authorization-rule keys.

Commands

Name	Description	Type	Status
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 keys list

Edit

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

az eventhubs eventhub authorization-rule keys list --authorization-rule-name --name
                                                   --eventhub-name
                                                   --namespace-name
                                                   --resource-group

Examples

Shows the connection strings of Authorizationrule for the eventhub.

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

Required Parameters

--authorization-rule-name --name

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

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

Edit

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

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

Examples

Regenerate the connection strings of Authorizationrule for the namespace

az eventhubs eventhub authorization-rule keys renew --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --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.

--authorization-rule-name --name

The authorization rule name.

Property	Value
Parameter group:	Resource Id Arguments

--eventhub-name

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

--key-value

Optional, if the key value provided, is set for KeyType or autogenerated 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

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

Feedback

Was this page helpful?