You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-signalr/howto-shared-private-endpoints-key-vault.md
+40-40Lines changed: 40 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
-
title: Access Key Vault in private network through Shared Private Endpoints
2
+
title: Access Key Vault in a private network through shared private endpoints
3
3
titleSuffix: Azure SignalR Service
4
-
description: How to access key vault in private network through Shared Private Endpoints
4
+
description: Learn how Azure SignalR Service can use shared private endpoints to avoid exposing your key vault on a public network.
5
5
services: signalr
6
6
author: ArchangelSDY
7
7
ms.service: signalr
@@ -10,44 +10,44 @@ ms.date: 09/23/2022
10
10
ms.author: dayshen
11
11
---
12
12
13
-
# Access Key Vault in private network through Shared Private Endpoints
13
+
# Access Key Vault in a private network through shared private endpoints
14
14
15
-
Azure SignalR Service can access your Key Vault in private network through Shared Private Endpoints. In this way you don't have to expose your Key Vault on public network.
15
+
Azure SignalR Service can access your Azure Key Vault instance in a private network through shared private endpoints. In this way, you don't have to expose your key vault on a public network.
:::image type="content" alt-text="Diagram that shows the architecture of a shared private endpoint." source="media\howto-shared-private-endpoints-key-vault\shared-private-endpoint-overview.png" :::
18
18
19
-
## Shared Private Link Resources Management
19
+
## Management of shared private link resources
20
20
21
-
Private endpoints of secured resources that are created through Azure SignalR Service APIs are referred to as *shared private link resources*. This is because you're "sharing" access to a resource, such as an Azure Key Vault, that has been integrated with the [Azure Private Link service](https://azure.microsoft.com/services/private-link/). These private endpoints are created inside Azure SignalR Service execution environment and aren't directly visible to you.
21
+
Private endpoints of secured resources that are created through Azure SignalR Service APIs are called *shared private link resources*. This is because you're "sharing" access to a resource, such a key vault, that has been integrated with the [Azure Private Link service](https://azure.microsoft.com/services/private-link/). These private endpoints are created inside an Azure SignalR Service execution environment and aren't directly visible to you.
22
22
23
23
> [!NOTE]
24
24
> The examples in this article are based on the following assumptions:
25
-
> * The resource ID of this Azure SignalR Service is _/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.SignalRService/signalr/contoso-signalr_.
26
-
> * The resource ID of Azure Key Vault is _/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.KeyVault/vaults/contoso-kv_.
25
+
> * The resource ID of the Azure SignalR Service instance is _/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.SignalRService/signalr/contoso-signalr_.
26
+
> * The resource ID of the key vault is _/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.KeyVault/vaults/contoso-kv_.
27
27
28
-
The rest of the examples show how the *contoso-signalr* service can be configured so that its outbound calls to Key Vault go through a private endpoint rather than public network.
28
+
The examples show how the *contoso-signalr* service can be configured so that its outbound calls to the key vault go through a private endpoint rather than a public network.
29
29
30
-
### Step 1: Create a shared private link resource to the Key Vault
30
+
##Create a shared private link resource to the key vault
31
31
32
-
####[Azure portal](#tab/azure-portal)
32
+
### [Azure portal](#tab/azure-portal)
33
33
34
34
1. In the Azure portal, go to your Azure SignalR Service resource.
35
-
1.In the menu pane, select **Networking**. Switch to **Private access** tab.
36
-
1.Click**Add shared private endpoint**.
35
+
1.On the menu pane, select **Networking**. Switch to the**Private access** tab.
:::image type="content" alt-text="Screenshot of the button for adding a shared private endpoint." source="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-management.png" lightbox="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-management.png" :::
39
39
40
40
1. Fill in a name for the shared private endpoint.
41
-
1. Select the target linked resource either by selecting from your owned resources or by filling a resource ID.
42
-
1.Click**Add**.
41
+
1. Select the target linked resource either by selecting from your owned resources or by filling in a resource ID.
42
+
1.Select**Add**.
43
43
44
44
:::image type="content" alt-text="Screenshot of adding a shared private endpoint." source="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-add.png" :::
45
45
46
-
1.The shared private endpoint resource will be in **Succeeded** provisioning state. The connection state is **Pending**approval at target resource side.
46
+
1.Confirm that the shared private endpoint resource is now in a **Succeeded** provisioning state. The connection state is **Pending**at the target resource side.
47
47
48
48
:::image type="content" alt-text="Screenshot of an added shared private endpoint." source="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-added.png" lightbox="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-added.png" :::
49
49
50
-
####[Azure CLI](#tab/azure-cli)
50
+
### [Azure CLI](#tab/azure-cli)
51
51
52
52
You can make the following API call with the [Azure CLI](/cli/azure/) to create a shared private link resource:
53
53
@@ -76,33 +76,33 @@ The process of creating an outbound private endpoint is a long-running (asynchro
76
76
77
77
You can poll this URI periodically to obtain the status of the operation.
78
78
79
-
If you're using the CLI, you can poll for the status by manually querying the `Azure-AsyncOperationHeader` value,
79
+
If you're using the CLI, you can poll for the status by manually querying the `Azure-AsyncOperationHeader` value:
80
80
81
81
```dotnetcli
82
82
az rest --method get --uri https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.SignalRService/signalr/contoso-signalr/operationStatuses/c0786383-8d5f-4554-8d17-f16fcf482fb2?api-version=2021-06-01-preview
83
83
```
84
84
85
-
Wait until the status changes to "Succeeded" before proceeding to the next steps.
85
+
Wait until the status changes to **Succeeded** before you proceed to the next steps.
86
86
87
87
-----
88
88
89
-
### Step 2a: Approve the private endpoint connection for the Key Vault
89
+
##Approve the private endpoint connection for the key vault
90
90
91
-
####[Azure portal](#tab/azure-portal)
91
+
### [Azure portal](#tab/azure-portal)
92
92
93
-
1. In the Azure portal, select the **Networking** tab of your Key Vault and navigate to **Private endpoint connections**. After the asynchronous operation has succeeded, there should be a request for a private endpoint connection with the request message from the previous API call.
93
+
1. In the Azure portal, select the **Networking** tab for your key vault and go to **Private endpoint connections**. After the asynchronous operation has succeeded, there should be a request for a private endpoint connection with the request message from the previous API call.
94
94
95
-
:::image type="content" alt-text="Screenshot of the Azure portal, showing the Private endpoint connections pane." source="media\howto-shared-private-endpoints-key-vault\portal-key-vault-approve-private-endpoint.png" :::
95
+
1. Select the private endpoint that Azure SignalR Service created. Then select **Approve**.
96
96
97
-
1. Select the private endpoint that Azure SignalR Service created. Click **Approve**.
97
+
:::image type="content" alt-text="Screenshot of the Azure portal that shows the pane for private endpoint connections." source="media\howto-shared-private-endpoints-key-vault\portal-key-vault-approve-private-endpoint.png" :::
98
+
99
+
1. Make sure that the private endpoint connection appears, as shown in the following screenshot. It could take one to two minutes for the status to be updated in the portal.
98
100
99
-
Make sure that the private endpoint connection appears as shown in the following screenshot. It could take one to two minutes for the status to be updated in the portal.
101
+
:::image type="content" alt-text="Screenshot of the Azure portal that shows an Approved status on the pane for private endpoint connections." source="media\howto-shared-private-endpoints-key-vault\portal-key-vault-approved-private-endpoint.png" :::
100
102
101
-
:::image type="content" alt-text="Screenshot of the Azure portal, showing an Approved status on the Private endpoint connections pane." source="media\howto-shared-private-endpoints-key-vault\portal-key-vault-approved-private-endpoint.png" :::
103
+
### [Azure CLI](#tab/azure-cli)
102
104
103
-
#### [Azure CLI](#tab/azure-cli)
104
-
105
-
1. List private endpoint connections.
105
+
1. List private endpoint connections:
106
106
107
107
```dotnetcli
108
108
az network private-endpoint-connection list -n <key-vault-resource-name> -g <key-vault-resource-group-name> --type 'Microsoft.KeyVault/vaults'
@@ -127,29 +127,29 @@ Wait until the status changes to "Succeeded" before proceeding to the next steps
127
127
]
128
128
```
129
129
130
-
1. Approve the private endpoint connection.
130
+
1. Approve the private endpoint connection:
131
131
132
132
```dotnetcli
133
133
az network private-endpoint-connection approve --id <private-endpoint-connection-id>
134
134
```
135
135
136
136
-----
137
137
138
-
### Step 2b: Query the status of the shared private link resource
138
+
## Query the status of the shared private link resource
139
139
140
-
It takes minutes for the approval to be propagated to Azure SignalR Service. You can check the state using either Azure portal or Azure CLI.
140
+
It takes minutes for the approval to be propagated to Azure SignalR Service. You can check the state by using either the Azure portal or the Azure CLI.
141
141
142
-
#### [Azure portal](#tab/azure-portal)
142
+
### [Azure portal](#tab/azure-portal)
143
143
144
144
:::image type="content" alt-text="Screenshot of an approved shared private endpoint." source="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-approved.png" lightbox="media\howto-shared-private-endpoints-key-vault\portal-shared-private-endpoints-approved.png" :::
145
145
146
-
#### [Azure CLI](#tab/azure-cli)
146
+
### [Azure CLI](#tab/azure-cli)
147
147
148
148
```dotnetcli
149
149
az rest --method get --uri https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.SignalRService/signalr/contoso-signalr/sharedPrivateLinkResources/func-pe?api-version=2021-06-01-preview
150
150
```
151
151
152
-
This would return a JSON, where the connection state would show up as "status" under the "properties" section.
152
+
This command returns JSON that shows the connection state as the `status` value in the `properties` section.
153
153
154
154
```json
155
155
{
@@ -165,17 +165,17 @@ This would return a JSON, where the connection state would show up as "status" u
165
165
166
166
```
167
167
168
-
If the "Provisioning State" (`properties.provisioningState`) of the resource is `Succeeded` and "Connection State" (`properties.status`) is `Approved`, it means that the shared private link resource is functional and Azure SignalR Service can communicate over the private endpoint.
168
+
If the provisioning state (`properties.provisioningState`) of the resource is `Succeeded` and the connection state (`properties.status`) is `Approved`, the shared private link resource is functional and Azure SignalR Service can communicate over the private endpoint.
169
169
170
170
-----
171
171
172
172
At this point, the private endpoint between Azure SignalR Service and Azure Key Vault is established.
173
173
174
-
Now you can configure features like custom domain as usual. **You don't have to use a special domain for Key Vault**. DNS resolution is automatically handled by Azure SignalR Service.
174
+
Now you can configure features like custom domain as usual. *You don't have to use a special domain for Key Vault*. Azure SignalR Service automatically handles DNS resolution.
175
175
176
176
## Next steps
177
177
178
178
Learn more:
179
179
180
180
+[What are private endpoints?](../private-link/private-endpoint-overview.md)
0 commit comments