Skip to content

Commit 5479f44

Browse files
authored
Merge pull request #174763 from jonburchel/2010-10-06-update-managed-identity-doc-for-synapse-uami-support-release
Breaks out Credentials from managed identity article and rebrands for Synapse & ADF both
2 parents 44eedce + 02bc8d4 commit 5479f44

23 files changed

+359
-72
lines changed

articles/data-factory/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,8 @@ items:
707707
- name: Encrypt credentials for self-hosted integration runtime
708708
href: encrypt-credentials-self-hosted-integration-runtime.md
709709
displayName: self hosted
710+
- name: Credentials in Data Factory
711+
href: credentials.md
710712
- name: Managed identity for Data Factory
711713
href: data-factory-service-identity.md
712714
- name: Encrypt data factory with customer managed key

articles/data-factory/concepts-linked-services.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,9 @@ Reference [compute environments supported](compute-linked-services.md) for detai
104104

105105
## Next steps
106106

107-
See the following tutorial for step-by-step instructions for creating pipelines and datasets by using one of these tools or SDKs.
107+
- [Learn how to use credentials from a user-assigned managed identity in a linked service](credentials.md).
108+
109+
See the following tutorials for step-by-step instructions for creating pipelines and datasets by using one of these tools or SDKs.
108110

109111
- [Quickstart: create a Data Factory using .NET](quickstart-create-data-factory-dot-net.md)
110112
- [Quickstart: create a Data Factory using PowerShell](quickstart-create-data-factory-powershell.md)

articles/data-factory/connector-azure-blob-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ For general information about Azure storage authentication, see [Authenticate ac
342342
- **As source**, in **Access control (IAM)**, grant at least the **Storage Blob Data Reader** role.
343343
- **As sink**, in **Access control (IAM)**, grant at least the **Storage Blob Data Contributor** role.
344344

345-
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](data-factory-service-identity.md#credentials) for each user-assigned managed identity.
345+
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](credentials.md) for each user-assigned managed identity.
346346

347347

348348
These properties are supported for an Azure Blob storage linked service:

articles/data-factory/connector-azure-data-explorer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ To use user-assigned managed identity authentication, follow these steps:
180180
- **As source**, grant at least the **Database viewer** role to your database
181181
- **As sink**, grant at least the **Database ingestor** role to your database
182182

183-
2. Assign one or multiple user-assigned managed identities to your data factory or Synapse workspace, and [create credentials](data-factory-service-identity.md#credentials) for each user-assigned managed identity.
183+
2. Assign one or multiple user-assigned managed identities to your data factory or Synapse workspace, and [create credentials](credentials.md) for each user-assigned managed identity.
184184

185185
The following properties are supported for the Azure Data Explorer linked service:
186186

articles/data-factory/connector-azure-data-lake-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ To use user-assigned managed identity authentication, follow these steps:
258258
- **As source**: In Storage Explorer, grant at least **Execute** permission for ALL upstream folders and the file system, along with **Read** permission for the files to copy. Alternatively, in Access control (IAM), grant at least the **Storage Blob Data Reader** role.
259259
- **As sink**: In Storage Explorer, grant at least **Execute** permission for ALL upstream folders and the file system, along with **Write** permission for the sink folder. Alternatively, in Access control (IAM), grant at least the **Storage Blob Data Contributor** role.
260260

261-
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](data-factory-service-identity.md#credentials) for each user-assigned managed identity.
261+
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](credentials.md) for each user-assigned managed identity.
262262

263263
These properties are supported for the linked service:
264264

articles/data-factory/connector-azure-data-lake-store.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ To use user-assigned managed identity authentication, follow these steps:
182182
- **As source**: In **Data explorer** > **Access**, grant at least **Execute** permission for ALL upstream folders including the root, along with **Read** permission for the files to copy. You can choose to add to **This folder and all children** for recursive, and add as **an access permission and a default permission entry**. There's no requirement on account-level access control (IAM).
183183
- **As sink**: In **Data explorer** > **Access**, grant at least **Execute** permission for ALL upstream folders including the root, along with **Write** permission for the sink folder. You can choose to add to **This folder and all children** for recursive, and add as **an access permission and a default permission entry**.
184184

185-
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](data-factory-service-identity.md#credentials) for each user-assigned managed identity.
185+
2. Assign one or multiple user-assigned managed identities to your data factory and [create credentials](credentials.md) for each user-assigned managed identity.
186186

187187
The following property is supported:
188188

articles/data-factory/credentials.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Using credentials
3+
titleSuffix: Azure Data Factory & Azure Synapse
4+
description: Learn about using Azure credentials for Azure Data Factory.
5+
author: nabhishek
6+
ms.service: data-factory
7+
ms.subservice: security
8+
ms.topic: conceptual
9+
ms.date: 07/19/2021
10+
ms.author: abnarain
11+
ms.custom: synapse
12+
---
13+
14+
# Credentials in Azure Data Factory and Azure Synapse
15+
16+
[!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
17+
18+
## Prerequisites
19+
20+
Users must have the Managed Identity Operator (Azure RBAC) role or a custom role with **Microsoft.ManagedIdentity/userAssignedIdentities/*/assign/action** RBAC action to configure a user assigned managed identity as a credential. Additional RBAC is required to create and use credentials in Synapse. [Learn more](../synapse-analytics/security/synapse-workspace-synapse-rbac-roles.md).
21+
22+
## Using credentials
23+
24+
We are introducing Credentials which can contain user-assigned managed identities, service principals, and also lists the system-assigned managed identity that you can use in the linked services that support Azure Active Directory (AAD) authentication. It helps you consolidate and manage all your AAD-based credentials.
25+
26+
Below are the generic steps for using a **user-assigned managed identity** in the linked services for authentication.
27+
28+
# [Azure Data Factory](#tab/data-factory)
29+
30+
1. If you do not have a user-assigned managed identity created in Azure, first create one in the Azure portal [Managed Identities](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.ManagedIdentity%2FuserAssignedIdentities) page.
31+
32+
1. Associate the user-assigned managed identity to the data factory instance using Azure portal, SDK, PowerShell, REST API. The screenshot below used Azure portal (data factory blade) to associate the user-assigned managed identity.
33+
34+
:::image type="content" source="media/credentials/uami-azure-portal.png" alt-text="Screenshot showing how to use Azure portal to associate an user-assigned managed identity.":::
35+
36+
1. Create a **Credential** in data factory user interface interactively. You can select the user-assigned managed identity associated with the data factory in Step 1.
37+
38+
:::image type="content" source="media/credentials/create-new-credential.png" alt-text="Screenshot showing the creation of new credentials.":::
39+
40+
:::image type="content" source="media/credentials/user-assigned-credential-configuration.png" alt-text="Screenshot showing the configuration of new credentials.":::
41+
42+
1. Create a new linked service and select **User-assigned managed identity** under authentication
43+
44+
:::image type="content" source="media/credentials/create-new-linked-service.png" alt-text="Screenshot showing the new linked service with user-assigned managed identity authentication.":::
45+
46+
:::image type="content" source="media/credentials/linked-service-credential-configuration.png" alt-text="Screenshot showing the new linked service configuration with User-Assigned Managed Identity and credentials selected.":::
47+
48+
# [Azure Synapse](#tab/synapse-analytics)
49+
50+
1. If you do not have a user-assigned managed identity created in Azure, first create one in the Azure portal [Managed Identities](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.ManagedIdentity%2FuserAssignedIdentities) page.
51+
52+
1. Associate the user-assigned managed identity to the workspace using Azure portal, SDK, PowerShell, REST API. The screenshot below used Azure portal (Identity blade) to associate the user-assigned managed identity.
53+
54+
:::image type="content" source="media/credentials/synapse-uami-azure-portal.png" alt-text="Screenshot showing how to use Azure portal to associate an user-assigned managed identity.":::
55+
56+
1. Create a **Credential** in Synapse Studio interactively. You can select the user-assigned managed identity associated with the workspace in Step 1.
57+
58+
:::image type="content" source="media/credentials/synapse-create-new-credential.png" alt-text="Screenshot showing the creation of new credentials.":::
59+
60+
:::image type="content" source="media/credentials/user-assigned-credential-configuration.png" alt-text="Screenshot showing the configuration of new credentials.":::
61+
62+
1. Create a new linked service and select **User-assigned managed identity** under authentication
63+
64+
:::image type="content" source="media/credentials/synapse-create-new-linked-service.png" alt-text="Screenshot showing the new linked service with user-assigned managed identity authentication.":::
65+
66+
:::image type="content" source="media/credentials/linked-service-credential-configuration.png" alt-text="Screenshot showing the new linked service configuration with User-Assigned Managed Identity and credentials selected.":::
67+
68+
---
69+
70+
> [!NOTE]
71+
> You can use SDK/ PowerShell/ REST APIs for the above actions.
72+
73+
## Next steps
74+
75+
- [Managed identity](data-factory-service-identity.md)
76+
77+
See the following topics that introduce when and how to use managed identity:
78+
79+
- [Store credential in Azure Key Vault](store-credentials-in-key-vault.md)
80+
- [Copy data from/to Azure Data Lake Store using managed identities for Azure resources authentication](connector-azure-data-lake-store.md)
81+
82+
See [Managed Identities for Azure Resources Overview](../active-directory/managed-identities-azure-resources/overview.md) for more background on managed identities for Azure resources, which data factory managed identity is based upon.

0 commit comments

Comments
 (0)