Share via

az relay namespace authorization-rule

Manage Azure Relay Service Namespace Authorization Rule.

Commands

Name Description Type Status
az relay namespace authorization-rule create

Create Authorization Rule for the given Relay Service Namespace.

 Core GA
az relay namespace authorization-rule delete

Deletes the Authorization Rule of the Relay Service Namespace.

 Core GA
az relay namespace authorization-rule keys

Manage Azure Authorization Rule connection strings for Namespace.

 Core GA
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 list

Shows the list of Authorization Rule by Relay Service Namespace.

 Core GA
az relay namespace authorization-rule show

Shows the details of Relay Service Namespace Authorization Rule.

 Core GA
az relay namespace authorization-rule update

Updates Authorization Rule for the given Relay Service Namespace.

 Core GA

az relay namespace authorization-rule create

Edit

Create Authorization Rule for the given Relay Service Namespace.

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

Examples

Create Authorization Rule 'myrule' for the given Relay Service Namespace 'mynamespace' in resourcegroup

az relay namespace authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --rights Send Listen

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

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

--rights

Space-separated list of Authorization rule rights. Allowed values: Listen, Manage, Send. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Edit

Deletes the Authorization Rule of the Relay Service Namespace.

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

Examples

Deletes the Authorization Rule of the Relay Service Namespace.

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

--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
--name -n

Name of Namespace Authorization Rule.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

Name of Namespace.

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

Edit

Shows the list of Authorization Rule by Relay Service Namespace.

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

Examples

Shows the list of Authorization Rule by Relay Service Namespace

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

Required Parameters

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

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

Edit

Shows the details of Relay Service Namespace Authorization Rule.

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

Examples

Shows the details of Relay Service Namespace Authorization Rule

az relay namespace authorization-rule show --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.

--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
--name -n

Name of Namespace Authorization Rule.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

Name of Namespace.

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

Edit

Updates Authorization Rule for the given Relay Service Namespace.

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

Examples

Updates Authorization Rule 'myrule' for the given Relay Service Namespace 'mynamespace' in resourcegroup

az relay 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
--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
--name -n

Name of Namespace Authorization Rule.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

Name of Namespace.

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

Space-separated list of Authorization rule rights. Allowed values: Listen, Manage, Send. 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>.

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