az relay namespace
Manage Azure Relay Service Namespace.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az relay namespace authorization-rule |
Manage Azure Relay Service Namespace Authorization Rule. |
Core | GA |
| 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 create |
Create a Relay Service Namespace. |
Core | GA |
| az relay namespace delete |
Deletes the Relay Service Namespace. |
Core | GA |
| az relay namespace exists |
Check for the availability of the given name for the Namespace. |
Core | GA |
| az relay namespace list |
List the Relay Service Namespaces. |
Core | GA |
| az relay namespace network-rule-set |
Manage Network Rule Set. |
Core | GA |
| az relay namespace network-rule-set create |
Create NetworkRuleSet for a Namespace. |
Core | GA |
| az relay namespace network-rule-set ip-rule |
Manage Azure Relay ip-rules in networkruleSet for namespace. |
Core | GA |
| az relay namespace network-rule-set ip-rule add |
Add an IP-Rule for network rule of namespace. |
Core | GA |
| az relay namespace network-rule-set ip-rule remove |
Remove Ip-Rule from network rule of namespace. |
Core | GA |
| az relay namespace network-rule-set show |
Get NetworkRuleSet for a Namespace. |
Core | GA |
| az relay namespace network-rule-set update |
Update NetworkRuleSet for a Namespace. |
Core | GA |
| az relay namespace private-endpoint-connection |
Manage Private Endpoint Connection. |
Core | GA |
| az relay namespace private-endpoint-connection create |
Create PrivateEndpointConnections of service namespace. |
Core | GA |
| az relay namespace private-endpoint-connection delete |
Delete an existing namespace. This operation also removes all associated resources under the namespace. |
Core | GA |
| az relay namespace private-endpoint-connection list |
List the available PrivateEndpointConnections within a namespace. |
Core | GA |
| az relay namespace private-endpoint-connection show |
Get a description for the specified Private Endpoint Connection name. |
Core | GA |
| az relay namespace private-endpoint-connection update |
Update PrivateEndpointConnections of service namespace. |
Core | GA |
| az relay namespace private-endpoint-connection wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az relay namespace private-link-resource |
Manage Private Link Resource. |
Core | GA |
| az relay namespace private-link-resource list |
List the private link resources for a container registry. |
Core | GA |
| az relay namespace private-link-resource show |
Get a private link resource by a specified group name for a container registry. |
Core | GA |
| az relay namespace show |
Shows the Relay Service Namespace details. |
Core | GA |
| az relay namespace update |
Updates a Relay Service Namespace. |
Core | GA |
| az relay namespace wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az relay namespace create
Create a Relay Service Namespace.
az relay namespace create --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--cluster-arm-id]
[--endpoint-connections --private-endpoint-connections]
[--location]
[--minimum-tls-version {1.2, 1.3}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
[--sku {Standard}]
[--tags]
[--tier {Standard}]
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 of Namespace.
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Cluster ARM ID of the Namespace.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
List of private endpoint connections. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.
The minimum TLS version for the namespace. Supported values are 1.2 and 1.3. The service defaults to 1.2 when the property is omitted. Existing namespaces configured with TLS 1.0 or 1.1 are reported as TLS 1.2.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | 1.2, 1.3 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
This determines if traffic is allowed over public network. By default it is enabled.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Default value: | Enabled |
| Accepted values: | Disabled, Enabled, SecuredByPerimeter |
Name of this SKU.
| Property | Value |
|---|---|
| Parameter group: | Sku Arguments |
| Accepted values: | Standard |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The tier of this SKU.
| Property | Value |
|---|---|
| Parameter group: | Sku Arguments |
| Accepted values: | Standard |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace delete
Deletes the Relay Service Namespace.
az relay namespace delete [--acquire-policy-token]
[--change-reference]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Deletes the Relay Service Namespace
az relay namespace delete --resource-group myresourcegroup --name mynamespace
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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 of Namespace.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace exists
Check for the availability of the given name for the Namespace.
az relay namespace exists --name
[--acquire-policy-token]
[--change-reference]
Examples
check for the availability of mynamespace for the Namespace
az relay namespace exists --name mynamespace
Required Parameters
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace list
List the Relay Service Namespaces.
az relay namespace list [--max-items]
[--next-token]
[--resource-group]
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace show
Shows the Relay Service Namespace details.
az relay namespace show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
shows the Namespace details.
az relay namespace show --resource-group myresourcegroup --name mynamespace
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 of Namespace.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace update
Updates a Relay Service Namespace.
az relay namespace update [--acquire-policy-token]
[--add]
[--change-reference]
[--cluster-arm-id]
[--endpoint-connections --private-endpoint-connections]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--minimum-tls-version {1.2, 1.3}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
[--remove]
[--resource-group]
[--set]
[--sku {Standard}]
[--subscription]
[--tags]
[--tier {Standard}]
Examples
Updates a Relay Service Namespace.
az relay namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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 |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Cluster ARM ID of the Namespace.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
List of private endpoint connections. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
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 |
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 |
The minimum TLS version for the namespace. Supported values are 1.2 and 1.3. The service defaults to 1.2 when the property is omitted. Existing namespaces configured with TLS 1.0 or 1.1 are reported as TLS 1.2.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | 1.2, 1.3 |
Name of Namespace.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
This determines if traffic is allowed over public network. By default it is enabled.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled, SecuredByPerimeter |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Name of this SKU.
| Property | Value |
|---|---|
| Parameter group: | Sku Arguments |
| Accepted values: | Standard |
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 |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The tier of this SKU.
| Property | Value |
|---|---|
| Parameter group: | Sku Arguments |
| Accepted values: | Standard |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az relay namespace wait
Place the CLI in a waiting state until a condition is met.
az relay namespace wait [--acquire-policy-token]
[--change-reference]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of Namespace.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |