az relay namespace authorization-rule keys

Manage Azure Authorization Rule connection strings for Namespace.

Commands

az relay namespace authorization-rule keys list

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

az relay namespace authorization-rule keys renew

Regenerate keys of Authorization Rule for the Relay Service Namespace.

az relay namespace authorization-rule keys list

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
                                                [--query-examples]
                                                [--subscription]

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az relay namespace authorization-rule keys renew

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 provided, is set for KeyType or autogenerated Key value set for keyType.

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