az relay namespace

Manage Azure Relay Service Namespace.

Commands

az relay namespace authorization-rule

Manage Azure Relay Service Namespace Authorization Rule.

az relay namespace authorization-rule create

Create Authorization Rule for the given Relay Service Namespace.

az relay namespace authorization-rule delete

Deletes the Authorization Rule of the Relay Service Namespace.

az relay namespace authorization-rule keys

Manage Azure Authorization Rule connection strings for 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 renew

Regenerate keys of Authorization Rule for the Relay Service Namespace.

az relay namespace authorization-rule list

Shows the list of Authorization Rule by Relay Service Namespace.

az relay namespace authorization-rule show

Shows the details of Relay Service Namespace Authorization Rule.

az relay namespace authorization-rule update

Updates Authorization Rule for the given Relay Service Namespace.

az relay namespace create

Create a Relay Service Namespace.

az relay namespace delete

Deletes the Relay Service Namespace.

az relay namespace exists

Check for the availability of the given name for the Namespace.

az relay namespace list

List the Relay Service Namespaces.

az relay namespace show

Shows the Relay Service Namespace details.

az relay namespace update

Updates a Relay Service Namespace.

az relay namespace create

Create a Relay Service Namespace.

az relay namespace create --name
                          --resource-group
                          [--location]
                          [--subscription]
                          [--tags]

Examples

Create a Relay Service Namespace.

az relay namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2

Required Parameters

--name -n

Name of Namespace.

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az relay namespace delete

Deletes the Relay Service Namespace.

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

Examples

Deletes the Relay Service Namespace

az relay namespace delete --resource-group myresourcegroup --name mynamespace

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.

--name -n

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.

az relay namespace exists

Check for the availability of the given name for the Namespace.

az relay namespace exists --name
                          [--subscription]

Examples

check for the availability of mynamespace for the Namespace

az relay namespace exists --name mynamespace

Required Parameters

--name -n

Namespace name. Name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

Optional Parameters

--subscription

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

az relay namespace list

List the Relay Service Namespaces.

az relay namespace list [--query-examples]
                        [--resource-group]
                        [--subscription]

Examples

Get the Relay Service Namespaces by resource group

az relay namespace list --resource-group myresourcegroup

Get the Relay Service Namespaces by Subscription.

az relay namespace list

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.

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

az relay namespace show

Shows the Relay Service Namespace details.

az relay namespace show [--ids]
                        [--name]
                        [--query-examples]
                        [--resource-group]
                        [--subscription]

Examples

shows the Namespace details.

az relay namespace show --resource-group myresourcegroup --name mynamespace

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.

--name -n

Name of Namespace.

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

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

az relay namespace update

Updates a Relay Service Namespace.

az relay namespace update [--add]
                          [--force-string]
                          [--ids]
                          [--name]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]
                          [--tags]

Examples

Updates a Relay Service Namespace.

az relay namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value

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

--force-string

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

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

--name -n

Name of Namespace.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.