Skip to content

Commit 492ad40

Browse files
authored
Merge pull request #179438 from whhender/UAMI-Update
Updating docs for UAMI
2 parents 6eed3c7 + 7885734 commit 492ad40

11 files changed

+195
-128
lines changed

articles/purview/create-catalog-portal.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 'Quickstart: Create a Purview account in the Azure portal'
33
description: This Quickstart describes how to create an Azure Purview account and configure permissions to begin using it.
44
author: nayenama
55
ms.author: nayenama
6-
ms.date: 09/27/2021
6+
ms.date: 11/15/2021
77
ms.topic: quickstart
88
ms.service: purview
99
ms.custom: mode-portal
@@ -67,8 +67,14 @@ After your Azure Purview account is created, you'll use the Purview Studio to ac
6767

6868
In this quickstart, you learned how to create an Azure Purview account and how to access it through the Purview Studio.
6969

70-
Follow these next articles to learn how to navigate the Purview Studio, create a collection, and grant access to Purview.
70+
Next, you can create a user-assigned managed identity (UAMI) that will enable your new Azure Purview account to authenticate directly with resources using Azure Active Directory (Azure AD) authentication.
71+
72+
To create a UAMI follow our [guide to create a user-assigned managed identity](manage-credentials.md#create-a-user-assigned-managed-identity).
73+
74+
Follow these next articles to learn how to navigate the Purview Studio, create a collection, and grant access to Purview:
7175

7276
* [Using the Purview Studio](use-purview-studio.md)
7377
* [Create a collection](quickstart-create-collection.md)
7478
* [Add users to your Azure Purview account](catalog-permissions.md)
79+
80+

articles/purview/manage-credentials.md

Lines changed: 60 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: viseshag
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 05/08/2021
9+
ms.date: 11/10/2021
1010
ms.custom: ignite-fall-2021
1111
---
1212

@@ -24,18 +24,20 @@ A credential is authentication information that Azure Purview can use to authent
2424

2525
In Azure Purview, there are few options to use as authentication method to scan data sources such as the following options:
2626

27-
- Azure Purview Managed Identity
28-
- Account Key (using Key Vault)
29-
- SQL Authentication (using Key Vault)
30-
- Service Principal (using Key Vault)
27+
- [Azure Purview system-assigned managed identity](#use-purview-system-assigned-managed-identity-to-set-up-scans)
28+
- [User-assigned managed identity](#create-a-user-assigned-managed-identity) (preview)
29+
- Account Key (using [Key Vault](#create-azure-key-vaults-connections-in-your-azure-purview-account))
30+
- SQL Authentication (using [Key Vault](#create-azure-key-vaults-connections-in-your-azure-purview-account))
31+
- Service Principal (using [Key Vault](#create-azure-key-vaults-connections-in-your-azure-purview-account))
32+
- Consumer Key (using [Key Vault](#create-azure-key-vaults-connections-in-your-azure-purview-account))
3133

3234
Before creating any credentials, consider your data source types and networking requirements to decide which authentication method is needed for your scenario. Review the following decision tree to find which credential is most suitable:
3335

3436
:::image type="content" source="media/manage-credentials/manage-credentials-decision-tree-small.png" alt-text="Manage credentials decision tree" lightbox="media/manage-credentials/manage-credentials-decision-tree.png":::
3537

36-
## Use Purview managed identity to set up scans
38+
## Use Purview system-assigned managed identity to set up scans
3739

38-
If you are using the Purview managed identity to set up scans, you will not have to explicitly create a credential and link your key vault to Purview to store them. For detailed instructions on adding the Purview managed identity to have access to scan your data sources, refer to the data source-specific authentication sections below:
40+
If you are using the Purview system-assigned managed identity (SAMI) to set up scans, you will not have to explicitly create a credential and link your key vault to Purview to store them. For detailed instructions on adding the Purview SAMI to have access to scan your data sources, refer to the data source-specific authentication sections below:
3941

4042
- [Azure Blob Storage](register-scan-azure-blob-storage-source.md#authentication-for-a-scan)
4143
- [Azure Data Lake Storage Gen1](register-scan-adls-gen1.md#authentication-for-a-scan)
@@ -62,14 +64,14 @@ Before you can create a Credential, first associate one or more of your existing
6264

6365
:::image type="content" source="media/manage-credentials/view-kv-connections.png" alt-text="View Azure Key Vault connections to confirm.":::
6466

65-
## Grant the Purview managed identity access to your Azure Key Vault
67+
## Grant Azure Purview access to your Azure Key Vault
6668

6769
Currently Azure Key Vault supports two permission models:
6870

6971
- Option 1 - Access Policies
7072
- Option 2 - Role-based Access Control
7173

72-
Before assigning access to Purview managed identity, first identify your Azure Key Vault permission model from Key Vault resource **Access Policies** in the menu. Follow steps below based on relevant the permission model.
74+
Before assigning access to the Purview system-assigned managed identity (SAMI), first identify your Azure Key Vault permission model from Key Vault resource **Access Policies** in the menu. Follow steps below based on relevant the permission model.
7375

7476
:::image type="content" source="media/manage-credentials/akv-permission-model.png" alt-text="Azure Key Vault Permission Model":::
7577

@@ -83,11 +85,11 @@ Follow these steps only if permission model in your Azure Key Vault resource is
8385

8486
3. Select **Add Access Policy**.
8587

86-
:::image type="content" source="media/manage-credentials/add-msi-to-akv-2.png" alt-text="Add Purview MSI to AKV":::
88+
:::image type="content" source="media/manage-credentials/add-msi-to-akv-2.png" alt-text="Add Purview managed identity to AKV":::
8789

8890
4. In the **Secrets permissions** dropdown, select **Get** and **List** permissions.
8991

90-
5. For **Select principal**, choose the Purview managed identity. You can search for the Purview MSI using either the Purview instance name **or** the managed identity application ID. We do not currently support compound identities (managed identity name + application ID).
92+
5. For **Select principal**, choose the Purview system managed identity. You can search for the Purview SAMI using either the Purview instance name **or** the managed identity application ID. We do not currently support compound identities (managed identity name + application ID).
9193

9294
:::image type="content" source="media/manage-credentials/add-access-policy.png" alt-text="Add access policy":::
9395

@@ -107,7 +109,7 @@ Follow these steps only if permission model in your Azure Key Vault resource is
107109

108110
3. Select **+ Add**.
109111

110-
4. Set the **Role** to **Key Vault Secrets User** and enter your enter your Azure Purview account name under **Select** input box. Then, select Save to give this role assignment to your Purview account.
112+
4. Set the **Role** to **Key Vault Secrets User** and enter your Azure Purview account name under **Select** input box. Then, select Save to give this role assignment to your Purview account.
111113

112114
:::image type="content" source="media/manage-credentials/akv-add-rbac.png" alt-text="Azure Key Vault RBAC":::
113115

@@ -120,7 +122,9 @@ These credential types are supported in Purview:
120122
- Service Principal: You add the **service principal key** as a secret in key vault.
121123
- SQL authentication: You add the **password** as a secret in key vault.
122124
- Account Key: You add the **account key** as a secret in key vault.
123-
- Role ARN: For an Amazon S3 data source, add your **role ARN** in AWS.
125+
- Role ARN: For an Amazon S3 data source, add your **role ARN** in AWS.
126+
- Consumer Key: For Salesforce data sources, you can add the **password** and the **consumer secret** in key vault.
127+
- User-assigned managed identity (preview): You can add user-assigned managed identity credentials. For more information, see the [create a user-assigned managed identity section](#create-a-user-assigned-managed-identity) below.
124128

125129
For more information, see [Add a secret to Key Vault](../key-vault/secrets/quick-create-portal.md#add-a-secret-to-key-vault) and [Create a new AWS role for Purview](register-scan-amazon-s3.md#create-a-new-aws-role-for-purview).
126130

@@ -158,6 +162,49 @@ After storing your secrets in the key vault:
158162

159163
3. Delete one or more Credentials.
160164

165+
## Create a user-assigned managed identity
166+
167+
User-assigned managed identities (UAMI) enable Azure resources to authenticate directly with other resources using Azure Active Directory (Azure AD) authentication, without the need to manage those credentials. They allow you to authenticate and assign access just like you would with a system assigned managed identity, Azure AD user, Azure AD group, or service principal. User-assigned managed identities are created as their own resource (rather than being connected to a pre-existing resource). For more information about managed identities, see the [managed identities for Azure resources documentation](../active-directory/managed-identities-azure-resources/overview.md).
168+
169+
The following steps will show you how to create a UAMI for Purview to use.
170+
171+
### Supported data sources for UAMI
172+
173+
* [Azure Data Lake Gen 1](register-scan-adls-gen1.md)
174+
* [Azure Data Lake Gen 2](register-scan-adls-gen2.md)
175+
* [Azure SQL Database](register-scan-azure-sql-database.md)
176+
* [Azure SQL Database Managed Instance](register-scan-azure-sql-database-managed-instance.md)
177+
* [Azure SQL Dedicated SQL pools](register-scan-azure-synapse-analytics.md)
178+
* [Azure Blob Storage](register-scan-azure-blob-storage-source.md)
179+
180+
### Create a user-assigned managed identity
181+
182+
1. In the [Azure Portal](https://portal.azure.com/) navigate to your Azure Purview account.
183+
184+
1. In the **Managed identities** section on the left menu, select the **+ Add** button to add user assigned managed identities.
185+
186+
:::image type="content" source="media/manage-credentials/create-new-managed-identity.png" alt-text="Screenshot showing managed identity screen in the Azure portal with user-assigned and add highlighted.":::
187+
188+
1. After finishing the setup, go back to your Azure Purview account in the Azure Portal. If the managed identity is successfully deployed, you'll see the Azure Purview account's status as **Succeeded**.
189+
190+
:::image type="content" source="media/manage-credentials/status-successful.png" alt-text="Screenshot the Azure Purview account in the Azure Portal with Status highlighted under the overview tab and essentials menu.":::
191+
192+
193+
1. Once the managed identity is successfully deployed, navigate to the [Purview Studio](https://web.purview.azure.com/), by selecting the **Open Purview Studio** button.
194+
195+
1. In the [Purview Studio](https://web.purview.azure.com/), navigate to the Management Center in the studio and then navigate to the Credentials section.
196+
197+
1. Create a user-assigned managed identity by selecting **+New**.
198+
1. Select the Managed identity authentication method, and select your user assigned managed identity from the drop down menu.
199+
200+
:::image type="content" source="media/manage-credentials/new-user-assigned-managed-identity-credential.png" alt-text="Screenshot showing the new managed identity creation tile, with the Learn More link highlighted.":::
201+
202+
>[!NOTE]
203+
> If the portal was open during creation of your user assigned managed identity, you'll need to refresh the Purview web portal to load the settings finished in the Azure portal.
204+
205+
1. After all the information is filled in, select **Create**.
206+
207+
161208
## Next steps
162209

163210
[Create a scan rule set](create-a-scan-rule-set.md)
144 KB
Loading
62.7 KB
Loading
42.8 KB
Loading

0 commit comments

Comments
 (0)