Merge pull request #273432 from shellyhaverkamp/smh-net-sec

American-Dipper · web-flow · commit 22dd3c2c9c33 · 2024-05-06T16:06:56.000-07:00
Network access security article
diff --git a/articles/healthcare-apis/.openpublishing.redirection.healthcare-apis.json b/articles/healthcare-apis/.openpublishing.redirection.healthcare-apis.json
@@ -91,8 +91,8 @@
           "redirect_document_id": true
       },
       {
-          "source_path_from_root": "/articles/healthcare-apis/configure-private-link.md",
-          "redirect_url": "/azure/healthcare-apis/fhir/configure-private-link",
+          "source_path_from_root": "/articles/healthcare-apis/healthcare-apis-configure-private-link.md",
+          "redirect_url": "/azure/healthcare-apis/configure-private-link",
           "redirect_document_id": true
       },
       {
diff --git a/articles/healthcare-apis/configure-private-link.md b/articles/healthcare-apis/configure-private-link.md
@@ -1,18 +1,18 @@
 ---
-title: Private Link for Azure Health Data Services
-description: This article describes how to set up a private endpoint for Azure Health Data Services
+title: Configure Private Link for Azure Health Data Services
+description: Learn how to set up Private Link for secure access to Azure Health Data Services.
 services: healthcare-apis
-author: chachachachami
+author: msjasteppe
 ms.service: healthcare-apis
 ms.subservice: fhir
 ms.topic: reference
-ms.date: 06/06/2022
-ms.author: chrupa
+ms.date: 05/06/2024
+ms.author: jasteppe
 ---
 
 # Configure Private Link for Azure Health Data Services
 
-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.
+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.
 
 >[!Note]
 > 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
 
 Before you create a private endpoint, the following Azure resources must be created first:
 
-- **Resource Group** – The Azure resource group that will contain the virtual network and private endpoint.
-- **Workspace** – This is a logical container for FHIR and DICOM service instances.
-- **Virtual Network** – The VNet to which your client services and private endpoint will be connected.
+- **Resource Group** – The Azure resource group that contains the virtual network and private endpoint.
+- **Workspace** – The logical container for FHIR&reg; and DICOM&reg; service instances.
+- **Virtual Network** – The virtual network to which your client services and private endpoint is connected.
 
 For more information, see [Private Link Documentation](./../private-link/index.yml).
 
@@ -35,7 +35,7 @@ To create a private endpoint, a user with Role-based access control (RBAC) permi
 
 Private link is configured at the workspace level, and is automatically configured for all FHIR and DICOM services within the workspace.
 
-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.
+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 that owners of the workspace or resource group approve the private endpoint.
 
 > [!NOTE]
 > 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
 
 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.
 
-[![Screen image of the Azure portal Basics Tab.](media/private-link/private-link-basics.png)](media/private-link/private-link-basics.png#lightbox)
+:::image type="content" source="media/private-link/private-link-basics.png" alt-text="Screenshot showing image of the Azure portal Basics Tab.":::
 
 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.
 
-[![Screen image of the Azure portal Resource tab.](media/private-link/private-link-resource.png)](media/private-link/private-link-resource.png#lightbox)
+:::image type="content" source="media/private-link/private-link-resource.png" alt-text="Screenshot showing image of the Azure portal Resource tab.":::
 
 ### Manual approval
 
 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.
 
-[![Screen image of the Manual Approval Resources tab.](media/private-link/private-link-resource-id.png)](media/private-link/private-link-resource-id.png#lightbox)
+:::image type="content" source="media/private-link/private-link-resource-id.png" alt-text="Screen image of the Manual Approval Resources tab.":::
 
 ### Private Link DNS configuration
 
 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.
 
-[![Screen image of the Azure portal DNS Configuration.](media/private-link/private-link-dns-configuration.png)](media/private-link/private-link-dns-configuration.png#lightbox)
+:::image type="content" source="media/private-link/private-link-dns-configuration.png" alt-text="Screenshot showing image of the Azure portal DNS Configuration.":::
 
 ### Private Link Mapping
 
-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.
+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.
 
-[![Screen image of Private Link FHIR Mapping.](media/private-link/private-link-fhir-map.png)](media/private-link/private-link-fhir-map.png#lightbox)
+:::image type="content" source="media/private-link/private-link-fhir-map.png" alt-text="Screenshot showing image of Private Link FHIR Mapping.":::
 
-Select **Virtual network links** from the **Settings**. You'll notice the FHIR service is linked to the virtual network.
-
-[![Screen image of Private Link VNet Link FHIR.](media/private-link/private-link-vnet-link-fhir.png)](media/private-link/private-link-vnet-link-fhir.png#lightbox)
+Select **Virtual network links** from the **Settings**. Notice that the FHIR service is linked to the virtual network.
 
+:::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.":::
 
 Similarly, you can see the private link mapping for the DICOM service.
 
-[![Screen image of Private Link DICOM Mapping.](media/private-link/private-link-dicom-map.png)](media/private-link/private-link-dicom-map.png#lightbox)
+:::image type="content" source="media/private-link/private-link-dicom-map.png" alt-text="Screenshot showing image of Private Link DICOM Mapping.":::
 
 Also, you can see the DICOM service is linked to the virtual network.
 
-[![Screen image of Private Link VNet Link DICOM](media/private-link/private-link-vnet-link-dicom.png)](media/private-link/private-link-vnet-link-dicom.png#lightbox)
+:::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.":::
 
 ## Test private endpoint
 
 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. 
 
-> [!NOTE]
-> It can take up to 5 minutes after updating the public network access flag before public traffic is blocked.
+It can take up to 5 minutes after updating the public network access flag before public traffic is blocked.
 
 > [!IMPORTANT]
 > 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:
 2. Remote Desktop Protocols (RDP) into the VM.
 3. Access your FHIR server’s `/metadata` endpoint from the VM. You should receive the capability statement as a response.
 
-## Next steps
-
-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
-
->[!div class="nextstepaction"]
->[Overview of Azure Health Data Services](healthcare-apis-overview.md)
-
-FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
+[!INCLUDE [FHIR and DICOM trademark statement](./includes/healthcare-apis-fhir-dicom-trademark.md)]
diff --git a/articles/healthcare-apis/network-access-security.md b/articles/healthcare-apis/network-access-security.md
@@ -0,0 +1,53 @@
+---
+title: Manage network access security in Azure Health Data Services
+description: Learn about network access security and outbound connections for the FHIR, DICOM, and MedTech services in Azure Health Data Services.
+services: healthcare-apis
+author: timritzer
+ms.service: healthcare-apis
+ms.subservice: fhir
+ms.topic: conceptual
+ms.date: 05/06/2024
+ms.author: jasteppe
+---
+
+# Manage network access security in Azure Health Data Services
+
+Azure Health Data Services provides multiple options for securing network access to its features and for managing outbound connections made by the FHIR&reg;, DICOM&reg;, or MedTech services.
+
+## Private Link
+
+[Private Link](../private-link/index.yml) is a network isolation technique that allows access to Azure services, including Azure Health Data Services. Private Link allows data to flow over private Microsoft networks instead of the public internet. By using Private Link, you can allow access only to specified virtual networks, and lock down access to provisioned services. For more information, see [Configure Private Link](healthcare-apis-configure-private-link.md).
+
+## Microsoft Trusted Services
+
+Although most interactions with Azure Health Data Services are inbound requests, there are a few features of the services that need to make outbound connections to other resources. To control access from outbound connections, we recommend that you use the [Microsoft Trusted Service](../storage/common/storage-network-security.md) connections in the network settings of the target resource. Each outbound feature can have slightly different setup steps and intended target resources.
+
+Here's a list of features that can make outbound connections from Azure Health Data Services:
+
+### FHIR service
+
+- **Export**: [Allow FHIR service export as a Microsoft Trusted Service](fhir/configure-export-data.md)
+- **Import**: [Allow FHIR service import as a Microsoft Trusted Service](fhir/configure-import-data.md)
+- **Convert**: [Allow trusted services access to Azure Container Registry](../container-registry/allow-access-trusted-services.md)
+- **Events**: [Allow trusted services access to Azure Event Hubs](../event-hubs/event-hubs-service-endpoints.md)
+- **Customer-managed keys**: [Allow trusted services access to Azure Key Vault](../key-vault/general/overview-vnet-service-endpoints.md)
+
+### DICOM service
+
+- **Import, export, and analytical support**: [Allow trusted services access to Azure Storage accounts](../storage/common/storage-network-security.md)
+- **Events**: [Allow trusted services access to Azure Event Hubs](../event-hubs/event-hubs-service-endpoints.md)
+- **Customer-managed keys**: [Allow trusted services access to Azure Key Vault](../key-vault/general/overview-vnet-service-endpoints.md)
+
+### MedTech service
+
+- **Events**: [Allow trusted services access to Azure Event Hubs](../event-hubs/event-hubs-service-endpoints.md)
+
+## Service tags
+
+[Service tags](../virtual-network/service-tags-overview.md) are sets of IP addresses that correspond to an Azure Service, for example Azure Health Data Services. You can use tags to control access on several Azure networking offerings such as Network Security Groups, Azure Firewall, and more.
+
+Azure Health Data Services offers a [service tag](../virtual-network/service-tags-overview.md) `AzureHealthcareAPIs` that you can use to control access to and from the services. However, there are a few caveats that come with using Service Tags for network isolation, and we don't recommend relying on them. Instead, use the approaches described in this article for more granular controls. Service tags are shared across all users of a service, and all provisioned instances. Tags provide no isolation between customers within Azure Health Data Services, between separate instances of the workspaces, nor between the different service offerings.
+
+If you use service tags, keep in mind that they're a convenient way of keeping track of sets of IP addresses. However, tags aren't a substitute for proper network security measures.
+
+[!INCLUDE [FHIR and DICOM trademark statement](includes/healthcare-apis-fhir-dicom-trademark.md)]
diff --git a/articles/healthcare-apis/toc.yml b/articles/healthcare-apis/toc.yml
@@ -20,6 +20,8 @@
       href: ./azure-api-for-fhir/overview.md
     - name: Business continuity & disaster recovery
       href: business-continuity-disaster-recovery.md
+    - name: Manage network access security
+      href: network-access-security.md
 - name: Quickstarts
   items: 
     - name: Workspace provisioning

Original file line number	Diff line number	Diff line change
`@@ -91,8 +91,8 @@`
`91`	`91`	`"redirect_document_id": true`
`92`	`92`	`},`
`93`	`93`	`{`
`94`		`- "source_path_from_root": "/articles/healthcare-apis/configure-private-link.md",`
`95`		`- "redirect_url": "/azure/healthcare-apis/fhir/configure-private-link",`
	`94`	`+ "source_path_from_root": "/articles/healthcare-apis/healthcare-apis-configure-private-link.md",`
	`95`	`+ "redirect_url": "/azure/healthcare-apis/configure-private-link",`
`96`	`96`	`"redirect_document_id": true`
`97`	`97`	`},`
`98`	`98`	`{`