Skip to content

Commit b965764

Browse files
committed
Merge branch 'release-aio-ga' of https://github.com/MicrosoftDocs/azure-docs-pr into release-aio-ga
2 parents ac14cb9 + 9b1bc31 commit b965764

File tree

79 files changed

+481
-398
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+481
-398
lines changed

articles/iot-operations/connect-to-cloud/howto-configure-adlsv2-endpoint.md

Lines changed: 78 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,25 @@ To send data to Azure Data Lake Storage Gen2 in Azure IoT Operations, you can co
2121
## Prerequisites
2222

2323
- An instance of [Azure IoT Operations](../deploy-iot-ops/howto-deploy-iot-operations.md)
24-
- A [configured dataflow profile](howto-configure-dataflow-profile.md)
25-
- A [Azure Data Lake Storage Gen2 account](../../storage/blobs/create-data-lake-storage-account.md)
24+
- An [Azure Data Lake Storage Gen2 account](../../storage/blobs/create-data-lake-storage-account.md)
2625
- A pre-created storage container in the storage account
2726

28-
## Create an Azure Data Lake Storage Gen2 dataflow endpoint
27+
## Assign permission to managed identity
2928

30-
To configure a dataflow endpoint for Azure Data Lake Storage Gen2, we suggest using the managed identity of the Azure Arc-enabled Kubernetes cluster. This approach is secure and eliminates the need for secret management. Alternatively, you can authenticate with the storage account using an access token. When using an access token, you would need to create a Kubernetes secret containing the SAS token.
29+
To configure a dataflow endpoint for Azure Data Lake Storage Gen2, we recommend using either a user-assigned or system-assigned managed identity. This approach is secure and eliminates the need for managing credentials manually.
30+
31+
After the Azure Data Lake Storage Gen2 is created, you need to assign a role to the Azure IoT Operations managed identity that grants permission to write to the storage account.
32+
33+
If using system-assigned managed identity, in Azure portal, go to your Azure IoT Operations instance and select **Overview**. Copy the name of the extension listed after **Azure IoT Operations Arc extension**. For example, *azure-iot-operations-xxxx7*. Your system-assigned managed identity can be found using the same name of the Azure IoT Operations Arc extension.
34+
35+
Then, go to the Azure Storage account > **Access control (IAM)** > **Add role assignment**.
36+
37+
1. On the **Role** tab select an appropriate role like `Storage Blob Data Contributor`. This gives the managed identity the necessary permissions to write to the Azure Storage blob containers. To learn more, see [Authorize access to blobs using Microsoft Entra ID](../../storage/blobs/authorize-access-azure-active-directory.md).
38+
1. On the **Members** tab:
39+
1. If using system-assigned managed identity, for **Assign access to**, select **User, group, or service principal** option, then select **+ Select members** and search for the name of the Azure IoT Operations Arc extension.
40+
1. If using user-assigned managed identity, for **Assign access to**, select **Managed identity** option, then select **+ Select members** and search for your [user-assigned managed identity set up for cloud connections](../deploy-iot-ops/howto-enable-secure-settings.md#set-up-a-user-assigned-managed-identity-for-cloud-connections).
41+
42+
## Create dataflow endpoint for Azure Data Lake Storage Gen2
3143

3244
# [Portal](#tab/portal)
3345

@@ -42,7 +54,7 @@ To configure a dataflow endpoint for Azure Data Lake Storage Gen2, we suggest us
4254
| --------------------- | ------------------------------------------------------------------------------------------------- |
4355
| Name | The name of the dataflow endpoint. |
4456
| Host | The hostname of the Azure Data Lake Storage Gen2 endpoint in the format `<account>.blob.core.windows.net`. Replace the account placeholder with the endpoint account name. |
45-
| Authentication method | The method used for authentication. Choose *System assigned managed identity*, *User assigned managed identity*, or *Access token*. |
57+
| Authentication method | The method used for authentication. We recommend that you choose [*System assigned managed identity*](#system-assigned-managed-identity) or [*User assigned managed identity*](#user-assigned-managed-identity). |
4658
| Client ID | The client ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
4759
| Tenant ID | The tenant ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
4860
| Access token secret name | The name of the Kubernetes secret containing the SAS token. Required if using *Access token*. |
@@ -77,8 +89,8 @@ resource adlsGen2Endpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2
7789
dataLakeStorageSettings: {
7890
host: host
7991
authentication: {
80-
method: 'SystemAssignedManagedIdentity'
81-
systemAssignedManagedIdentitySettings: {}
92+
// See available authentication methods section for method types
93+
// method: <METHOD_TYPE>
8294
}
8395
}
8496
}
@@ -106,8 +118,8 @@ spec:
106118
dataLakeStorageSettings:
107119
host: https://<ACCOUNT>.blob.core.windows.net
108120
authentication:
109-
method: SystemAssignedManagedIdentity
110-
systemAssignedManagedIdentitySettings: {}
121+
# See available authentication methods section for method types
122+
# method: <METHOD_TYPE>
111123
```
112124

113125
Then apply the manifest file to the Kubernetes cluster.
@@ -118,8 +130,6 @@ kubectl apply -f <FILE>.yaml
118130

119131
---
120132

121-
If you need to override the system-assigned managed identity audience, see the [System-assigned managed identity](#system-assigned-managed-identity) section.
122-
123133
### Use access token authentication
124134

125135
Follow the steps in the [access token](#access-token) section to get a SAS token for the storage account and store it in a Kubernetes secret.
@@ -206,19 +216,17 @@ kubectl apply -f <FILE>.yaml
206216

207217
The following authentication methods are available for Azure Data Lake Storage Gen2 endpoints.
208218

209-
For more information about enabling secure settings by configuring an Azure Key Vault and enabling workload identities, see [Enable secure settings in Azure IoT Operations deployment](../deploy-iot-ops/howto-enable-secure-settings.md).
210-
211219
### System-assigned managed identity
212220

213-
Using the system-assigned managed identity is the recommended authentication method for Azure IoT Operations. Azure IoT Operations creates the managed identity automatically and assigns it to the Azure Arc-enabled Kubernetes cluster. It eliminates the need for secret management and allows for seamless authentication.
214-
215-
Before creating the dataflow endpoint, assign a role to the managed identity that has write permission to the storage account. For example, you can assign the *Storage Blob Data Contributor* role. To learn more about assigning roles to blobs, see [Authorize access to blobs using Microsoft Entra ID](../../storage/blobs/authorize-access-azure-active-directory.md).
221+
Before you configure the dataflow endpoint, assign a role to the Azure IoT Operations managed identity that grants permission to write to the storage account:
216222

217223
1. In Azure portal, go to your Azure IoT Operations instance and select **Overview**.
218224
1. Copy the name of the extension listed after **Azure IoT Operations Arc extension**. For example, *azure-iot-operations-xxxx7*.
219-
1. Search for the managed identity in the Azure portal by using the name of the extension. For example, search for *azure-iot-operations-xxxx7*.
220-
1. Assign a role to the Azure IoT Operations Arc extension managed identity that grants permission to write to the storage account, such as *Storage Blob Data Contributor*. To learn more, see [Authorize access to blobs using Microsoft Entra ID](../../storage/blobs/authorize-access-azure-active-directory.md).
221-
1. Create the *DataflowEndpoint* resource and specify the managed identity authentication method.
225+
1. Go to the cloud resource you need to grant permissions. For example, go to the Azure Storage account > **Access control (IAM)** > **Add role assignment**.
226+
1. On the **Role** tab select an appropriate role.
227+
1. On the **Members** tab, for **Assign access to**, select **User, group, or service principal** option, then select **+ Select members** and search for the Azure IoT Operations managed identity. For example, *azure-iot-operations-xxxx7*.
228+
229+
Then, configure the dataflow endpoint with system-assigned managed identity settings.
222230

223231
# [Portal](#tab/portal)
224232

@@ -279,6 +287,57 @@ dataLakeStorageSettings:
279287

280288
---
281289

290+
### User-assigned managed identity
291+
292+
To use user-assigned managed identity for authentication, you must first deploy Azure IoT Operations with secure settings enabled. Then you need to [set up a user-assigned managed identity for cloud connections](../deploy-iot-ops/howto-enable-secure-settings.md#set-up-a-user-assigned-managed-identity-for-cloud-connections). To learn more, see [Enable secure settings in Azure IoT Operations deployment](../deploy-iot-ops/howto-enable-secure-settings.md).
293+
294+
Before you configure the dataflow endpoint, assign a role to the user-assigned managed identity that grants permission to write to the storage account:
295+
296+
1. In Azure portal, go to the cloud resource you need to grant permissions. For example, go to the Azure Storage account > **Access control (IAM)** > **Add role assignment**.
297+
1. On the **Role** tab select an appropriate role.
298+
1. On the **Members** tab, for **Assign access to**, select **Managed identity** option, then select **+ Select members** and search for your user-assigned managed identity.
299+
300+
Then, configure the dataflow endpoint with user-assigned managed identity settings.
301+
302+
# [Portal](#tab/portal)
303+
304+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **User assigned managed identity**.
305+
306+
Enter the user assigned managed identity client ID and tenant ID in the appropriate fields.
307+
308+
# [Bicep](#tab/bicep)
309+
310+
```bicep
311+
dataLakeStorageSettings: {
312+
authentication: {
313+
method: 'UserAssignedManagedIdentity'
314+
userAssignedManagedIdentitySettings: {
315+
cliendId: '<ID>'
316+
tenantId: '<ID>'
317+
// Optional, defaults to 'https://storage.azure.com/.default'
318+
// scope: 'https://<SCOPE_URL>'
319+
}
320+
}
321+
}
322+
```
323+
324+
# [Kubernetes (preview)](#tab/kubernetes)
325+
326+
```yaml
327+
dataLakeStorageSettings:
328+
authentication:
329+
method: UserAssignedManagedIdentity
330+
userAssignedManagedIdentitySettings:
331+
clientId: <ID>
332+
tenantId: <ID>
333+
# Optional, defaults to 'https://storage.azure.com/.default'
334+
# scope: https://<SCOPE_URL>
335+
```
336+
337+
---
338+
339+
Here, the scope is optional and defaults to `https://storage.azure.com/.default`. If you need to override the default scope, specify the `scope` setting via the Bicep or Kubernetes manifest.
340+
282341
### Access token
283342

284343
Using an access token is an alternative authentication method. This method requires you to create a Kubernetes secret with the SAS token and reference the secret in the *DataflowEndpoint* resource.
@@ -347,51 +406,6 @@ dataLakeStorageSettings:
347406

348407
---
349408

350-
### User-assigned managed identity
351-
352-
To use user-managed identity for authentication, you must first deploy Azure IoT Operations with secure settings enabled. To learn more, see [Enable secure settings in Azure IoT Operations deployment](../deploy-iot-ops/howto-enable-secure-settings.md).
353-
354-
Then, specify the user-assigned managed identity authentication method along with the client ID, tenant ID, and scope of the managed identity.
355-
356-
# [Portal](#tab/portal)
357-
358-
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **User assigned managed identity**.
359-
360-
Enter the user assigned managed identity client ID and tenant ID in the appropriate fields.
361-
362-
# [Bicep](#tab/bicep)
363-
364-
```bicep
365-
dataLakeStorageSettings: {
366-
authentication: {
367-
method: 'UserAssignedManagedIdentity'
368-
userAssignedManagedIdentitySettings: {
369-
cliendId: '<ID>'
370-
tenantId: '<ID>'
371-
// Optional, defaults to 'https://storage.azure.com/.default'
372-
// scope: 'https://<SCOPE_URL>'
373-
}
374-
}
375-
}
376-
```
377-
378-
# [Kubernetes (preview)](#tab/kubernetes)
379-
380-
```yaml
381-
dataLakeStorageSettings:
382-
authentication:
383-
method: UserAssignedManagedIdentity
384-
userAssignedManagedIdentitySettings:
385-
clientId: <ID>
386-
tenantId: <ID>
387-
# Optional, defaults to 'https://storage.azure.com/.default'
388-
# scope: https://<SCOPE_URL>
389-
```
390-
391-
---
392-
393-
Here, the scope is optional and defaults to `https://storage.azure.com/.default`. If you need to override the default scope, specify the `scope` setting via the Bicep or Kubernetes manifest.
394-
395409
## Advanced settings
396410

397411
You can set advanced settings for the Azure Data Lake Storage Gen2 endpoint, such as the batching latency and message count.

0 commit comments

Comments
 (0)