az relay namespace private-endpoint-connection
Manage Private Endpoint Connection.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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-endpoint-connection create
Create PrivateEndpointConnections of service namespace.
az relay namespace private-endpoint-connection create --name --private-endpoint-connection-name
--namespace-name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--connection-state --private-link-service-connection-state]
[--private-endpoint]
[--provisioning-state {Canceled, Creating, Deleting, Failed, Succeeded, Updating}]
Examples
NameSpacePrivateEndPointConnectionCreate
az relay namespace private-endpoint-connection create --resource-group resourcegroup --namespace-name example-RelayNamespace-5849 --private-endpoint-connection-name {privateEndpointConnection name} --private-endpoint "{id:/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1}" --private-link-service-connection-state "{description:'You may pass',status:Approved}"
Required Parameters
The PrivateEndpointConnection name.
The namespace name.
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 |
Details about the state of the connection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The Private Endpoint resource for this Connection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Provisioning state of the Private Endpoint Connection.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Canceled, Creating, Deleting, Failed, Succeeded, Updating |
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 private-endpoint-connection delete
Delete an existing namespace. This operation also removes all associated resources under the namespace.
az relay namespace private-endpoint-connection delete [--acquire-policy-token]
[--change-reference]
[--ids]
[--name --private-endpoint-connection-name]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
NameSpacePrivateEndPointConnectionDelete
az relay namespace private-endpoint-connection delete --resource-group myResourceGroup --namespace-name example-RelayNamespace-5849 --private-endpoint-connection-name {privateEndpointConnection 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 |
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 PrivateEndpointConnection name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The namespace name.
| 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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| 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 |
az relay namespace private-endpoint-connection list
List the available PrivateEndpointConnections within a namespace.
az relay namespace private-endpoint-connection list --namespace-name
--resource-group
[--max-items]
[--next-token]
Examples
PrivateEndpointConnectionsList
az relay namespace private-endpoint-connection list --resource-group myResourceGroup --namespace-name example-RelayNamespace-5849
Required Parameters
The namespace name.
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.
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 |
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 private-endpoint-connection show
Get a description for the specified Private Endpoint Connection name.
az relay namespace private-endpoint-connection show [--ids]
[--name --private-endpoint-connection-name]
[--namespace-name]
[--resource-group]
[--subscription]
Examples
NameSpacePrivateEndPointConnectionGet
az relay namespace private-endpoint-connection show --resource-group myResourceGroup --namespace-name example-RelayNamespace-5849 --private-endpoint-connection-name {privateEndpointConnection 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.
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 PrivateEndpointConnection name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The namespace name.
| 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 private-endpoint-connection update
Update PrivateEndpointConnections of service namespace.
az relay namespace private-endpoint-connection update [--acquire-policy-token]
[--add]
[--change-reference]
[--connection-state --private-link-service-connection-state]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name --private-endpoint-connection-name]
[--namespace-name]
[--private-endpoint]
[--provisioning-state {Canceled, Creating, Deleting, Failed, Succeeded, Updating}]
[--remove]
[--resource-group]
[--set]
[--subscription]
Examples
NameSpacePrivateEndPointConnectionCreate
az relay namespace private-endpoint-connection update --resource-group resourcegroup --namespace-name example-RelayNamespace-5849 --private-endpoint-connection-name {privateEndpointConnection name} --private-endpoint "{id:/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1}" --private-link-service-connection-state "{description:'You may pass',status:Approved}"
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 |
Details about the state of the connection. 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 PrivateEndpointConnection name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The namespace name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The Private Endpoint resource for this Connection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Provisioning state of the Private Endpoint Connection.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Canceled, Creating, Deleting, Failed, Succeeded, Updating |
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 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 private-endpoint-connection wait
Place the CLI in a waiting state until a condition is met.
az relay namespace private-endpoint-connection wait [--acquire-policy-token]
[--change-reference]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --private-endpoint-connection-name]
[--namespace-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 |
The PrivateEndpointConnection name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The namespace name.
| 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 |