Skip to content

Commit 08227a5

Browse files
authored
Merge pull request #180241 from zxue/master
Consolidate AAD related docs
2 parents fdf182f + 1e666f2 commit 08227a5

16 files changed

+197
-123
lines changed

.openpublishing.redirection.healthcare-apis.json

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,6 @@
7272
"redirect_url": "/azure/healthcare-apis/azure-api-for-fhir/azure-api-for-fhir-additional-settings",
7373
"redirect_document_id": false
7474
},
75-
{
76-
"source_path_from_root": "/articles/healthcare-apis/configure-azure-rbac.md",
77-
"redirect_url": "/azure/healthcare-apis/fhir/configure-azure-rbac",
78-
"redirect_document_id": true
79-
},
8075
{
8176
"source_path_from_root": "/articles/healthcare-apis/configure-cross-origin-resource-sharing.md",
8277
"redirect_url": "/azure/healthcare-apis/fhir/configure-cross-origin-resource-sharing",
@@ -222,12 +217,7 @@
222217
"redirect_url": "/azure/healthcare-apis/azure-api-for-fhir/access-fhir-postman-tutorial",
223218
"redirect_document_id": true
224219
},
225-
{
226-
"source_path_from_root": "/articles/healthcare-apis/fhir/configure-azure-rbac.md",
227-
"redirect_url": "/azure/healthcare-apis/azure-api-for-fhir/configure-azure-rbac",
228-
"redirect_document_id": true
229-
},
230-
{
220+
{
231221
"source_path_from_root": "/articles/healthcare-apis/fhir/configure-database.md",
232222
"redirect_url": "/azure/healthcare-apis/azure-api-for-fhir/configure-database",
233223
"redirect_document_id": true
@@ -457,5 +447,50 @@
457447
"redirect_url": "/azure/healthcare-apis/security-controls-policy",
458448
"redirect_document_id": true
459449
},
450+
{
451+
"source_path_from_root": "/articles/healthcare-apis/fhir/azure-active-directory-identity-configuration.md",
452+
"redirect_url": "/azure/healthcare-apis/authentication-authorization",
453+
"redirect_document_id": true
454+
},
455+
{
456+
"source_path_from_root": "/articles/healthcare-apis/fhir/fhir-service-access-token-validation.md",
457+
"redirect_url": "/azure/healthcare-apis/get-access-token",
458+
"redirect_document_id": true
459+
},
460+
{
461+
"source_path_from_root": "/articles/healthcare-apis/fhir/get-healthcare-apis-access-token-cli.md",
462+
"redirect_url": "/azure/healthcare-apis/get-access-token",
463+
"redirect_document_id": false
464+
},
465+
{
466+
"source_path_from_root": "/articles/healthcare-apis/dicom/dicom-get-access-token-azure-cli.md",
467+
"redirect_url": "/azure/healthcare-apis/get-access-token",
468+
"redirect_document_id": false
469+
},
470+
{
471+
"source_path_from_root": "/articles/healthcare-apis/dicom/dicom-register-service-client-application.md",
472+
"redirect_url": "/azure/healthcare-apis/register-application",
473+
"redirect_document_id": true
474+
},
475+
{
476+
"source_path_from_root": "/articles/healthcare-apis/dicom/dicom-register-public-application.md",
477+
"redirect_url": "/azure/healthcare-apis/register-application",
478+
"redirect_document_id": false
479+
},
480+
{
481+
"source_path_from_root": "/articles/healthcare-apis/dicom/dicom-register-confidential-client-application.md",
482+
"redirect_url": "/azure/healthcare-apis/register-application",
483+
"redirect_document_id": false
484+
},
485+
{
486+
"source_path_from_root": "/articles/healthcare-apis/dicom/dicom-configure-azure-rbac.md",
487+
"redirect_url": "/azure/healthcare-apis/configure-azure-rbac",
488+
"redirect_document_id": true
489+
},
490+
{
491+
"source_path_from_root": "/articles/healthcare-apis/fhir/configure-azure-rbac-for-fhir.md",
492+
"redirect_url": "/azure/healthcare-apis/configure-azure-rbac",
493+
"redirect_document_id": false
494+
}
460495
]
461496
}
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: Configure Azure RBAC for FHIR service - Azure Healthcare APIs
3+
description: This article describes how to configure Azure RBAC for FHIR.
4+
author: SteveWohl
5+
ms.service: healthcare-apis
6+
ms.topic: tutorial
7+
ms.date: 11/17/2021
8+
ms.author: zxue
9+
---
10+
11+
# Configure Azure RBAC for Healthcare APIs
12+
13+
> [!IMPORTANT]
14+
> Azure Healthcare APIs is currently in PREVIEW. The [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
15+
16+
In this article, you'll learn how to use [Azure role-based access control (Azure RBAC)](../role-based-access-control/index.yml) to assign access to the Healthcare APIs data plane. Azure RBAC is the preferred methods for assigning data plane access when data plane users are managed in the Azure Active Directory tenant associated with your Azure subscription.
17+
18+
You can complete role assignments through the Azure portal. Note that the FHIR service and the DICOM service have defined different application roles. Add or remove one or more roles to manage user access controls.
19+
20+
## Assign roles for the FHIR service
21+
22+
To grant users, service principals, or groups access to the FHIR data plane, select the FHIR service from the Azure portal. Select **Access control (IAM)**, and then select the **Role assignments** tab. Select **+Add**, and then select **Add role assignment**.
23+
24+
If the role assignment option is grayed out, ask your Azure subscription administrator to grant you with the permissions to the subscription or the resource group, for example, “User Access Administrator”. For more information about the Azure built-in roles, see [Azure built-in roles](../role-based-access-control/built-in-roles.md).
25+
26+
[ ![Access control role assignment.](fhir/media/rbac/role-assignment.png) ](fhir/media/rbac/role-assignment.png#lightbox)
27+
28+
In the Role selection, search for one of the built-in roles for the FHIR data plane, for example, “FHIR Data Contributor”. You can choose other roles below.
29+
30+
* **FHIR Data Reader**: Can read (and search) FHIR data.
31+
* **FHIR Data Writer**: Can read, write, and soft delete FHIR data.
32+
* **FHIR Data Exporter**: Can read and export ($export operator) data.
33+
* **FHIR Data Contributor**: Can perform all data plane operations.
34+
* **FHIR Data Converter**: Can use the converter to perform data conversion
35+
36+
In the **Select** section, type the client application registration name. If the name is found, the application name is listed. Select the application name, and then select **Save**.
37+
38+
If the client application is not found, check your application registration, to ensure that the name is correct. Ensure that the client application is created in the same tenant where the FHIR service in the Azure Healthcare APIs (hereby called the FHIR service) is deployed in.
39+
40+
41+
[ ![Select role assignment.](fhir/media/rbac/select-role-assignment.png) ](fhir/media/rbac/select-role-assignment.png#lightbox)
42+
43+
You can verify the role assignment by selecting the **Role assignments** tab from the **Access control (IAM)** menu option.
44+
45+
## Assign roles for the DICOM service
46+
47+
To grant users, service principals, or groups access to the DICOM data plane, select the **Access control (IAM)** blade. Select the**Role assignments** tab, and select **+ Add**.
48+
49+
[ ![dicom access control.](dicom/media/dicom-access-control.png) ](dicom/media/dicom-access-control.png#lightbox)
50+
51+
In the **Role** selection, search for one of the built-in roles for the DICOM data plane:
52+
53+
[ ![Add RBAC role assignment.](dicom/media/rbac-add-role-assignment.png) ](dicom/media/rbac-add-role-assignment.png#lightbox)
54+
55+
You can choose between:
56+
57+
* DICOM Data Owner: Full access to DICOM data.
58+
* DICOM Data Reader: Read and search DICOM data.
59+
60+
If these roles are not sufficient for your need, you can use PowerShell to create custom roles. For information about creating custom roles, see [Create a custom role using Azure PowerShell](../role-based-access-control/custom-roles-powershell.md).
61+
62+
In the **Select** box, search for a user, service principal, or group that you want to assign the role to.
63+
64+
> [!NOTE]
65+
> If you can't access the FHIR or DICOM service in your application or other tools, you might need to wait a few more minutes for the role assignment to finish propagating in the system.
66+
67+
## Next steps
68+
69+
In this article, you've learned how to assign Azure roles for the FHIR service and DICOM service. To learn how to access the Healthcare APIs using Postman, see
70+
71+
- [Access using Postman](use-postman.md)
72+
- [Access using the REST Client](using-rest-client.md)
73+
- [Access using cURL](using-curl.md)

articles/healthcare-apis/dicom/dicom-configure-azure-rbac.md renamed to articles/healthcare-apis/dicom/dicom-configure-azure-rbac-old.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ The DICOM service will cache decisions for up to five minutes. If you grant a us
4444
In this article, you learned how to assign Azure roles for the DICOM service data plane.
4545

4646
>[!div class="nextstepaction"]
47-
>[Overview of the DICOM service](dicom-services-overview.md)
47+
>[Overview of the DICOM service](dicom-services-overview.md)

articles/healthcare-apis/dicom/dicom-get-access-token-azure-cli.md renamed to articles/healthcare-apis/dicom/dicom-get-access-token-azure-cli-old.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ curl -X GET --header "Authorization: Bearer $token" https://<workspacename-dico
5151
In this article, you've learned how to obtain an access token for the DICOM service using the Azure CLI.
5252

5353
>[!div class="nextstepaction"]
54-
>[Overview of the DICOM service](dicom-services-overview.md)
54+
>[Overview of the DICOM service](dicom-services-overview.md)

articles/healthcare-apis/dicom/toc.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,6 @@ items:
3636
items:
3737
- name: Pull DICOM changes using the Change Feed
3838
href: pull-dicom-changes-from-change-feed.md
39-
- name: Register a service client application
40-
href: dicom-register-service-client-application.md
41-
- name: Register a public client application
42-
href: dicom-register-public-application.md
43-
- name: Register a confidential client application
44-
href: dicom-register-confidential-client-application.md
45-
- name: Configure Azure RBAC for the DICOM service
46-
href: dicom-configure-azure-rbac.md
47-
- name: Get access token for the DICOM service using Azure CLI
48-
href: dicom-get-access-token-azure-cli.md
4939
- name: Resources
5040
expanded: true
5141
items:

articles/healthcare-apis/fhir/azure-active-directory-identity-configuration.md renamed to articles/healthcare-apis/fhir/azure-active-directory-identity-configuration-old.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ There are other variations (for example on behalf of flow) for obtaining a token
110110
In this document, you learned some of the basic concepts involved in securing access to the FHIR service using Azure AD. For information about how to deploy the FHIR service, see
111111

112112
>[!div class="nextstepaction"]
113-
>[Deploy the FHIR service](fhir-portal-quickstart.md)
113+
>[Deploy the FHIR service](fhir-portal-quickstart.md)

articles/healthcare-apis/fhir/configure-azure-rbac-for-fhir.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)