az network private-endpoint
Manage private endpoints.
Commands
az network private-endpoint create |
Create a private endpoint. |
az network private-endpoint delete |
Delete a private endpoint. |
az network private-endpoint dns-zone-group |
Manage private endpoint dns zone group. |
az network private-endpoint dns-zone-group add |
Add a private endpoint dns zone into a dns zone group. |
az network private-endpoint dns-zone-group create |
Create a private endpoint dns zone group. |
az network private-endpoint dns-zone-group delete |
Delete a private endpoint dns zone group. |
az network private-endpoint dns-zone-group list |
List all private endpoint dns zone groups. |
az network private-endpoint dns-zone-group remove |
Remove a private endpoint dns zone into a dns zone group. |
az network private-endpoint dns-zone-group show |
Show a private endpoint dns zone group. |
az network private-endpoint list |
List private endpoints. |
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 show |
Get the details of a private endpoint. |
az network private-endpoint update |
Update a private endpoint. |
az network private-endpoint create
Create a private endpoint.
az network private-endpoint create --connection-name
--name
--private-connection-resource-id
--resource-group
--subnet
[--group-id]
[--group-ids]
[--location]
[--manual-request {false, true}]
[--request-message]
[--subscription]
[--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
Required Parameters
Name of the private link service connection.
Name of the private endpoint.
The resource id of which private enpoint 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.
Optional Parameters
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.
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.
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.
A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
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.
The virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).
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.
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]
[--resource-group]
[--subscription]
Examples
Delete a private endpoint. (autogenerated)
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.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network private-endpoint list
List private endpoints.
az network private-endpoint list [--query-examples]
[--resource-group]
[--subscription]
Optional Parameters
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.
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
.
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.
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
[--subscription]
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
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 [--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
Examples
Get the details of a private endpoint (autogenerated)
az network private-endpoint show --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.
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.
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
.
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.
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]
[--ids]
[--name]
[--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. (autogenerated)
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.
Remove a property or an element from a list. Example: --remove property.list 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=.
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.
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.
Increase logging verbosity. Use --debug for full debug logs.