Share via

az relay namespace authorization-rule keys

  • Reference

Manage Azure Authorization Rule connection strings for Namespace.

Commands

Name Description Type Status
az relay namespace authorization-rule keys list

List the keys and connection strings of Authorization Rule for Relay Service Namespace.

 Core GA
az relay namespace authorization-rule keys renew

Regenerate keys of Authorization Rule for the Relay Service Namespace.

 Core GA

az relay namespace authorization-rule keys list

Edit

List the keys and connection strings of Authorization Rule for Relay Service Namespace.

az relay namespace authorization-rule keys list --name
                                                --namespace-name
                                                --resource-group

Examples

List the keys and connection strings of Authorization Rule for Relay Service Namespace

az relay namespace authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule

List the keys and connection strings of Authorization Rule for Relay Service Namespace (commonly used with --output and --query). (autogenerated)

az relay namespace authorization-rule keys list --name myauthorule --namespace-name mynamespace --resource-group myresourcegroup --subscription MySubscription

Required Parameters

--name -n

Name of Namespace Authorization Rule.

--namespace-name

Name of Namespace.

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

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

Edit

Regenerate keys of Authorization Rule for the Relay Service Namespace.

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

Examples

Regenerate keys of Authorization Rule for the Relay Service Namespace.

az relay namespace authorization-rule keys renew --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --key PrimaryKey

Required Parameters

--key

Specifies Primary or Secondary key needs to be reset.

Accepted values: PrimaryKey, SecondaryKey

Optional Parameters

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

--key-value

Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type.

--name -n

Name of Namespace Authorization Rule.

--namespace-name

Name of Namespace.

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