az network private-endpoint
Manage private endpoints.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network private-endpoint asg |
Manage private endpoint application security groups. |
Core | GA |
az network private-endpoint asg add |
Add a private endpoint application security group. |
Core | GA |
az network private-endpoint asg list |
List application security group within a private endpoint. |
Core | GA |
az network private-endpoint asg remove |
Remove a private endpoint application security group. |
Core | GA |
az network private-endpoint asg wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network private-endpoint create |
Create a private endpoint. |
Core | GA |
az network private-endpoint delete |
Delete a private endpoint. |
Core | GA |
az network private-endpoint dns-zone-group |
Manage private endpoint dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group add |
Add a private endpoint dns zone into a dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group create |
Create a private endpoint dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group delete |
Delete a private endpoint dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group list |
List all private endpoint dns zone groups. |
Core | GA |
az network private-endpoint dns-zone-group remove |
Remove a private endpoint dns zone into a dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group show |
Show a private endpoint dns zone group. |
Core | GA |
az network private-endpoint dns-zone-group wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network private-endpoint ip-config |
Manage private endpoint ip configurations. |
Core | GA |
az network private-endpoint ip-config add |
Add a private endpoint ip configuration. |
Core | GA |
az network private-endpoint ip-config list |
List ip configuration within a private endpoint. |
Core | GA |
az network private-endpoint ip-config remove |
Remove a private endpoint ip configuration. |
Core | GA |
az network private-endpoint ip-config wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network private-endpoint list |
List private endpoints. |
Core | GA |
az network private-endpoint list-types |
Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region. |
Core | GA |
az network private-endpoint show |
Get the details of a private endpoint. |
Core | GA |
az network private-endpoint update |
Update a private endpoint. |
Core | GA |
az network private-endpoint wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network private-endpoint create
Create a private endpoint.
az network private-endpoint create --connection-name
--name
--private-connection-resource-id
--resource-group
--subnet
[--asg]
[--edge-zone]
[--group-id]
[--ip-config]
[--location]
[--manual-request {0, 1, f, false, n, no, t, true, y, yes}]
[--nic-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--request-message]
[--tags]
[--vnet-name]
Examples
Create a private endpoint.
az network private-endpoint create -g MyResourceGroup -n MyPE --vnet-name MyVnetName --subnet MySubnet --private-connection-resource-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/privateLinkServices/MyPLS" --connection-name tttt -l centralus
Create a private endpoint with ASGs.
az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --asg id=MyAsgId --asg id=MyAsgId
Create a private endpoint with ip-configs.
az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --ip-configs [{name:Myipconfig1,group-id:MyGroupId ,member-name:MyMemberName,private-ip-address:10.0.0.4},{name:Myipconfig2,private-ip-address:10.0.0.6}]
Required Parameters
Name of the private link service connection.
Name of the private endpoint.
The resource id of the private endpoint to connect to.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of an existing subnet. If name specified, also specify --vnet-name. If you want to use an existing subnet in other resource group or subscription, please provide the ID instead of the name of the subnet and do not specify the--vnet-name.
Optional Parameters
The private endpoint application security groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --asg
.
The name of edge zone.
The ID of the group obtained from the remote resource that this private endpoint should connect to. You can use "az network private-link-resource list" to obtain the supported group ids. You must provide this except for PrivateLinkService., Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The private endpoint ip configurations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --ip-config
.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Use manual request to establish the connection. Configure it as 'true' when you don't have access to the subscription of private link service.
The custom name of the network interface attached to the private endpoint.
Do not wait for the long-running operation to finish.
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
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 virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint delete
Delete a private endpoint.
az network private-endpoint delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Delete a private endpoint.
az network private-endpoint delete --name MyPrivateEndpoint --resource-group MyResourceGroup
Optional Parameters
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 of the private endpoint.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint list
List private endpoints.
az network private-endpoint list [--resource-group]
Examples
List private endpoints.
az network private-endpoint list -g MyResourceGroup
Optional Parameters
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint list-types
Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.
az network private-endpoint list-types [--location]
[--resource-group]
Examples
List all of the resource types
az network private-endpoint list-types -l centralus
Optional Parameters
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.
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.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint show
Get the details of a private endpoint.
az network private-endpoint show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the details of a private endpoint
az network private-endpoint show --name MyPrivateEndpoint --resource-group MyResourceGroup
Optional Parameters
Expands referenced resources.
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 of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint update
Update a private endpoint.
az network private-endpoint update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--request-message]
[--resource-group]
[--set]
[--subscription]
[--tags]
Examples
Update a private endpoint.
az network private-endpoint update -g MyResourceGroup -n MyPE --request-message "test" --tags mytag=hello
Update a private endpoint.
az network private-endpoint update --name MyPE --resource-group MyResourceGroup --set useRemoteGateways=true
Optional Parameters
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 of the private endpoint.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value]...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network private-endpoint wait
Place the CLI in a waiting state until a condition is met.
az network private-endpoint wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Expands referenced resources.
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.
Polling interval in seconds.
Name of the private endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.