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
title: Private Link for Azure Health Data Services
3
-
description: This article describes how to set up a private endpoint for Azure Health Data Services
2
+
title: Configure Private Link for Azure Health Data Services
3
+
description: Learn how to set up Private Link for secure access to Azure Health Data Services.
4
4
services: healthcare-apis
5
-
author: chachachachami
5
+
author: msjasteppe
6
6
ms.service: healthcare-apis
7
7
ms.subservice: fhir
8
8
ms.topic: reference
9
-
ms.date: 06/06/2022
10
-
ms.author: chrupa
9
+
ms.date: 05/06/2024
10
+
ms.author: jasteppe
11
11
---
12
12
13
13
# Configure Private Link for Azure Health Data Services
14
14
15
-
Private Link enables you to access Azure Health Data Services over a private endpoint. Private Link is a network interface that connects you privately and securely using a private IP address from your virtual network. With Private Link, you can access our services securely from your VNet as a first party service without having to go through a public Domain Name System (DNS). This article describes how to create, test, and manage your Private Endpoint for Azure Health Data Services.
15
+
Private Link enables you to access Azure Health Data Services over a private endpoint. Private Link is a network interface that connects you privately and securely using a private IP address from your virtual network. With Private Link, you can access our services securely from your virtual network as a first party service without having to go through a public Domain Name System (DNS). This article describes how to create, test, and manage your Private Endpoint for Azure Health Data Services.
16
16
17
17
>[!Note]
18
18
> Neither Private Link nor Azure Health Data Services can be moved from one resource group or subscription to another once Private Link is enabled. To make a move, delete the Private Link first, and then move Azure Health Data Services. Create a new Private Link after the move is complete. Next, assess potential security ramifications before deleting the Private Link.
@@ -23,9 +23,9 @@ Private Link enables you to access Azure Health Data Services over a private end
23
23
24
24
Before you create a private endpoint, the following Azure resources must be created first:
25
25
26
-
-**Resource Group** – The Azure resource group that will contain the virtual network and private endpoint.
27
-
-**Workspace** – This is a logical container for FHIR and DICOM service instances.
28
-
-**Virtual Network** – The VNet to which your client services and private endpoint will be connected.
26
+
-**Resource Group** – The Azure resource group that contains the virtual network and private endpoint.
27
+
-**Workspace** – The logical container for FHIR® and DICOM® service instances.
28
+
-**Virtual Network** – The virtual network to which your client services and private endpoint is connected.
29
29
30
30
For more information, see [Private Link Documentation](./../private-link/index.yml).
31
31
@@ -35,7 +35,7 @@ To create a private endpoint, a user with Role-based access control (RBAC) permi
35
35
36
36
Private link is configured at the workspace level, and is automatically configured for all FHIR and DICOM services within the workspace.
37
37
38
-
There are two ways to create a private endpoint. Auto Approval flow allows a user that has RBAC permissions on the workspace to create a private endpoint without a need for approval. Manual Approval flow allows a user without permissions on the workspace to request a private endpoint to be approved by owners of the workspace or resource group.
38
+
There are two ways to create a private endpoint. Auto Approval flow allows a user that has RBAC permissions on the workspace to create a private endpoint without a need for approval. Manual Approval flow allows a user without permissions on the workspace to request a that owners of the workspace or resource group approve the private endpoint.
39
39
40
40
> [!NOTE]
41
41
> When an approved private endpoint is created for Azure Health Data Services, public traffic to it is automatically disabled.
@@ -44,49 +44,47 @@ There are two ways to create a private endpoint. Auto Approval flow allows a use
44
44
45
45
Ensure the region for the new private endpoint is the same as the region for your virtual network. The region for the workspace can be different.
46
46
47
-
[](media/private-link/private-link-basics.png#lightbox)
47
+
:::image type="content" source="media/private-link/private-link-basics.png" alt-text="Screenshot showing image of the Azure portal Basics Tab.":::
48
48
49
49
For the resource type, search and select **Microsoft.HealthcareApis/workspaces** from the drop-down list. For the resource, select the workspace in the resource group. The target subresource, **healthcareworkspace**, is automatically populated.
50
50
51
-
[](media/private-link/private-link-resource.png#lightbox)
51
+
:::image type="content" source="media/private-link/private-link-resource.png" alt-text="Screenshot showing image of the Azure portal Resource tab.":::
52
52
53
53
### Manual approval
54
54
55
55
For manual approval, select the second option under Resource, **Connect to an Azure resource by resource ID or alias**. For the resource ID, enter **subscriptions/{subcriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.HealthcareApis/workspaces/{workspacename}**. For the Target subresource, enter **healthcareworkspace** as in Auto Approval.
56
56
57
-
[](media/private-link/private-link-resource-id.png#lightbox)
57
+
:::image type="content" source="media/private-link/private-link-resource-id.png" alt-text="Screen image of the Manual Approval Resources tab.":::
58
58
59
59
### Private Link DNS configuration
60
60
61
61
After the deployment is complete, select the Private Link resource in the resource group. Open **DNS configuration** from the settings menu. You can find the DNS records and private IP addresses for the workspace, and FHIR and DICOM services.
62
62
63
-
[](media/private-link/private-link-dns-configuration.png#lightbox)
63
+
:::image type="content" source="media/private-link/private-link-dns-configuration.png" alt-text="Screenshot showing image of the Azure portal DNS Configuration.":::
64
64
65
65
### Private Link Mapping
66
66
67
-
After the deployment is complete, browse to the new resource group that is created as part of the deployment. You'll see two private DNS zone records and one for each service. If you have more FHIR and DICOM services in the workspace, additional DNS zone records will be created for them.
67
+
After the deployment is complete, browse to the new resource group that is created as part of the deployment. You should see two private DNS zone records and one for each service. If you have more FHIR and DICOM services in the workspace, more DNS zone records are created for them.
68
68
69
-
[](media/private-link/private-link-fhir-map.png#lightbox)
69
+
:::image type="content" source="media/private-link/private-link-fhir-map.png" alt-text="Screenshot showing image of Private Link FHIR Mapping.":::
70
70
71
-
Select **Virtual network links** from the **Settings**. You'll notice the FHIR service is linked to the virtual network.
72
-
73
-
[](media/private-link/private-link-vnet-link-fhir.png#lightbox)
71
+
Select **Virtual network links** from the **Settings**. Notice that the FHIR service is linked to the virtual network.
74
72
73
+
:::image type="content" source="media/private-link/private-link-vnet-link-fhir.png" alt-text="Screenshot showing image of Private Link virtual network Link FHIR.":::
75
74
76
75
Similarly, you can see the private link mapping for the DICOM service.
77
76
78
-
[](media/private-link/private-link-dicom-map.png#lightbox)
77
+
:::image type="content" source="media/private-link/private-link-dicom-map.png" alt-text="Screenshot showing image of Private Link DICOM Mapping.":::
79
78
80
79
Also, you can see the DICOM service is linked to the virtual network.
81
80
82
-
[](media/private-link/private-link-vnet-link-dicom.png#lightbox)
81
+
:::image type="content" source="media/private-link/private-link-vnet-link-dicom.png" alt-text="Screenshot showing image of Private Link virtual network Link DICOM.":::
83
82
84
83
## Test private endpoint
85
84
86
85
To verify that your service isn’t receiving public traffic after disabling public network access, select the `/metadata` endpoint for your FHIR service, or the /health/check endpoint of the DICOM service, and you'll receive the message 403 Forbidden.
87
86
88
-
> [!NOTE]
89
-
> It can take up to 5 minutes after updating the public network access flag before public traffic is blocked.
87
+
It can take up to 5 minutes after updating the public network access flag before public traffic is blocked.
90
88
91
89
> [!IMPORTANT]
92
90
> Every time a new service gets added into the Private Link enabled workspace, wait for the provisioning to complete. Refresh the private endpoint if DNS A records are not getting updated for the newly added service(s) in the workspace. If DNS A records are not updated in your private DNS zone, requests to a newly added service(s) will not go over Private Link.
@@ -97,11 +95,4 @@ To ensure your Private Endpoint can send traffic to your server:
97
95
2. Remote Desktop Protocols (RDP) into the VM.
98
96
3. Access your FHIR server’s `/metadata` endpoint from the VM. You should receive the capability statement as a response.
99
97
100
-
## Next steps
101
-
102
-
In this article, you've learned how to configure Private Link for Azure Health Data Services. Private Link is configured at the workspace level and all subresources, such as FHIR services and DICOM services with the workspace, are linked to the Private Link and the virtual network. For more information about Azure Health Data Services, see
103
-
104
-
>[!div class="nextstepaction"]
105
-
>[Overview of Azure Health Data Services](healthcare-apis-overview.md)
106
-
107
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
98
+
[!INCLUDE [FHIR and DICOM trademark statement](./includes/healthcare-apis-fhir-dicom-trademark.md)]
0 commit comments