Skip to content

Commit cf313ab

Browse files
authored
Merge pull request #174542 from asudbring/privlink-paas
Edited powershell and CLI commands to update article
2 parents d03db3a + 4101cd9 commit cf313ab

File tree

1 file changed

+84
-32
lines changed

1 file changed

+84
-32
lines changed

articles/private-link/manage-private-endpoint.md

Lines changed: 84 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,57 @@
11
---
22
title: Manage a Private Endpoint connection in Azure
3+
titleSuffix: Azure Private Link
34
description: Learn how to manage private endpoint connections in Azure
45
services: private-link
5-
author: malopMSFT
6+
author: asudbring
67
ms.service: private-link
78
ms.topic: how-to
8-
ms.date: 09/16/2019
9+
ms.date: 10/04/2021
910
ms.author: allensu
1011
ms.custom: devx-track-azurepowershell
1112

1213
---
1314
# Manage a Private Endpoint connection
14-
Azure Private Link works on an approval call flow model wherein the Private Link service consumer can request a connection to the service provider for consuming the service. The service provider can then decide whether to allow the consumer to connect or not. Azure Private Link enables the service providers to manage the private endpoint connection on their resources. This article provides instructions about how to manage the Private Endpoint connections.
15+
16+
Azure Private Link works on an approval model where the Private Link service consumer can request a connection to the service provider for consuming the service.
17+
18+
The service provider can then decide whether to allow the consumer to connect or not. Azure Private Link enables service providers to manage the private endpoint connection on their resources.
19+
20+
This article provides instructions about how to manage the Private Endpoint connections.
1521

1622
![Manage Private Endpoints](media/manage-private-endpoint/manage-private-endpoint.png)
1723

1824
There are two connection approval methods that a Private Link service consumer can choose from:
19-
- **Automatic**: If the service consumer has Azure RBAC permissions on the service provider resource, the consumer can choose the automatic approval method. In this case, when the request reaches the service provider resource, no action is required from the service provider and the connection is automatically approved.
20-
- **Manual**: On the contrary, if the service consumer doesn’t have Azure RBAC permissions on the service provider resource, the consumer can choose the manual approval method. In this case, the connection request appears on the service resources as **Pending**. The service provider has to manually approve the request before connections can be established.
25+
26+
- **Automatic**: If the service consumer has Azure Role Based Access Control permissions on the service provider resource, the consumer can choose the automatic approval method. When the request reaches the service provider resource, no action is required from the service provider and the connection is automatically approved.
27+
28+
- **Manual**: If the service consumer doesn’t have Azure Role Based Access Control permissions on the service provider resource, the consumer can choose the manual approval method. The connection request appears on the service resources as **Pending**. The service provider has to manually approve the request before connections can be established.
2129
In manual cases, service consumer can also specify a message with the request to provide more context to the service provider. The service provider has following options to choose from for all Private Endpoint connections: **Approved**, **Reject**, **Remove**.
2230

23-
The below table shows the various service provider actions and the resulting connection states for Private Endpoints. The service provider can also change the connection state of private endpoint connection at a later time without consumer intervention. The action will update the state of the endpoint on the consumer side.
31+
The below table shows the various service provider actions and the resulting connection states for Private Endpoints. The service provider can change the connection state at a later time without consumer intervention. The action will update the state of the endpoint on the consumer side.
2432

2533

26-
|Service Provider Action |Service Consumer Private Endpoint State |Description |
34+
| Service Provider Action | Service Consumer Private Endpoint State | Description |
2735
|---------|---------|---------|
28-
|None | Pending | Connection is created manually and is pending for approval by the Private Link resource owner. |
29-
|Approve | Approved | Connection was automatically or manually approved and is ready to be used. |
30-
|Reject | Rejected | Connection was rejected by the private link resource owner. |
31-
|Remove | Disconnected | Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean up. |
32-
| | | |
33-
34-
## Manage Private Endpoint Connections on Azure PaaS resources
35-
Portal is the preferred method for managing private endpoint connections on Azure PaaS resources.
36-
37-
1. Sign in to the Azure portal at https://portal.azure.com.
38-
2. Navigate to Private Link Center.
39-
3. Under **Resources**, select the resource type you want to manage the private endpoint connections.
40-
4. For each of your resource type, you can view the number of Private Endpoint Connections associated with it. You can filter the resources as needed.
41-
5. Select the private endpoint connections. Under the connections listed, select the connection that you want to manage.
36+
| None | Pending | Connection is created manually and is pending for approval by the Private Link resource owner. |
37+
| Approve | Approved | Connection was automatically or manually approved and is ready to be used. |
38+
| Reject | Rejected | Connection was rejected by the private link resource owner. |
39+
| Remove | Disconnected | Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up. |
40+
41+
## Manage Private Endpoint connections on Azure PaaS resources
42+
43+
The Azure portal is the preferred method for managing private endpoint connections on Azure PaaS resources.
44+
45+
1. Sign in to the [Azure portal](https://portal.azure.com).
46+
47+
2. In the search box at the top of the portal, enter **Private link**. In the search results, select **Private link**.
48+
49+
3. In the **Private link center**, select **Private endpoints** or **Private link services**.
50+
51+
4. For each of your endpoints, you can view the number of Private Endpoint connections associated with it. You can filter the resources as needed.
52+
53+
5. Select the private endpoint. Under the connections listed, select the connection that you want to manage.
54+
4255
6. You can change the state of the connection by selecting from the options at the top.
4356

4457
## Manage Private Endpoint connections on a customer/partner owned Private Link service
@@ -48,41 +61,80 @@ Azure PowerShell and Azure CLI are the preferred methods for managing Private En
4861
### PowerShell
4962

5063
Use the following PowerShell commands to manage private endpoint connections.
64+
5165
#### Get Private Link connection states
52-
Use the `Get-AzPrivateLinkService` cmdlet to get the Private Endpoint connections and their states.
66+
67+
Use [Get-AzPrivateEndpointConnection](/powershell/module/az.network/get-azprivateendpointconnection) to get the Private Endpoint connections and their states.
68+
5369
```azurepowershell
54-
Get-AzPrivateLinkService -Name myPrivateLinkService -ResourceGroupName myResourceGroup
55-
```
70+
Get-AzPrivateEndpointConnection -Name myPrivateLinkService -ResourceGroupName myResourceGroup
71+
```
5672

5773
#### Approve a Private Endpoint connection
5874

59-
Use the `Approve-AzPrivateEndpointConnection` cmdlet to approve a Private Endpoint connection.
75+
Use [Approve-AzPrivateEndpointConnection](/powershell/module/az.network/approve-azprivateendpointconnection) cmdlet to approve a Private Endpoint connection.
6076

6177
```azurepowershell
6278
Approve-AzPrivateEndpointConnection -Name myPrivateEndpointConnection -ResourceGroupName myResourceGroup -ServiceName myPrivateLinkService
6379
```
6480

6581
#### Deny Private Endpoint connection
6682

67-
Use the `Deny-AzPrivateEndpointConnection` cmdlet to reject a Private Endpoint connection.
83+
Use [Deny-AzPrivateEndpointConnection](/powershell/module/az.network/deny-azprivateendpointconnection) cmdlet to reject a Private Endpoint connection.
84+
6885
```azurepowershell
6986
Deny-AzPrivateEndpointConnection -Name myPrivateEndpointConnection -ResourceGroupName myResourceGroup -ServiceName myPrivateLinkService
7087
```
71-
#### Remove Private Endpoint Connection
88+
89+
#### Remove Private Endpoint connection
7290

73-
Use the `Remove-AzPrivateEndpointConnection` cmdlet to remove a Private Endpoint connection.
91+
Use [Remove-AzPrivateEndpointConnection](/powershell/module/az.network/remove-azprivateendpointconnection) cmdlet to remove a Private Endpoint connection.
92+
7493
```azurepowershell
75-
Remove-AzPrivateEndpointConnection -Name myPrivateEndpointConnection1 -ResourceGroupName myResourceGroup -ServiceName myPrivateLinkServiceName
94+
Remove-AzPrivateEndpointConnection -Name myPrivateEndpointConnection -ResourceGroupName myResourceGroup -ServiceName myPrivateLinkService
7695
```
7796

7897
### Azure CLI
7998

80-
Use `az network private-link-service update` for managing your Private Endpoint connections. The connection state is specified in the ```azurecli connection-status``` parameter.
99+
#### Get Private Link connection states
100+
101+
Use [az network private-endpoint-connection show](/cli/azure/network/private-endpoint-connection#az_network_private_endpoint_connection_show) to get the Private Endpoint connections and their states.
102+
103+
```azurecli
104+
az network private-endpoint-connection show \
105+
--name myPrivateEndpointConnection \
106+
--resource-group myResourceGroup
107+
```
108+
109+
#### Approve a Private Endpoint connection
110+
111+
Use [az network private-endpoint-connection approve](/cli/azure/network/private-endpoint-connection#az_network_private_endpoint_connection_approve) cmdlet to approve a Private Endpoint connection.
112+
81113
```azurecli
82-
az network private-link-service connection update -g myResourceGroup -n myPrivateEndpointConnection1 --service-name myPLS --connection-status Approved
114+
az network private-endpoint-connection approve \
115+
--name myPrivateEndpointConnection \
116+
--resource-group myResourceGroup
117+
```
118+
119+
#### Deny Private Endpoint connection
120+
121+
Use [az network private-endpoint-connection reject](/cli/azure/network/private-endpoint-connection#az_network_private_endpoint_connection_reject) cmdlet to reject a Private Endpoint connection.
122+
123+
```azurecli
124+
az network private-endpoint-connection reject \
125+
--name myPrivateEndpointConnection \
126+
--resource-group myResourceGroup
83127
```
84128

85-
129+
#### Remove Private Endpoint connection
130+
131+
Use [az network private-endpoint-connection delete](/cli/azure/network/private-endpoint-connection#az_network_private_endpoint_connection_delete) cmdlet to remove a Private Endpoint connection.
132+
133+
```azurecli
134+
az network private-endpoint-connection delete \
135+
--name myPrivateEndpointConnection \
136+
--resource-group myResourceGroup
137+
```
86138

87139
## Next steps
88140
- [Learn about Private Endpoints](private-endpoint-overview.md)

0 commit comments

Comments
 (0)