Skip to content

Commit ba1a7b0

Browse files
author
Jill Grant
authored
Merge pull request #289286 from PatAltimore/patricka-doe-release-aio-m3
Add operations experience changes - M3
2 parents fa6c792 + d8d4b9c commit ba1a7b0

23 files changed

+226
-67
lines changed

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

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: patricka
66
ms.service: azure-iot-operations
77
ms.subservice: azure-data-flows
88
ms.topic: how-to
9-
ms.date: 10/16/2024
9+
ms.date: 10/27/2024
1010
ai-usage: ai-assisted
1111

1212
#CustomerIntent: As an operator, I want to understand how to configure dataflow endpoints for Azure Data Lake Storage Gen2 in Azure IoT Operations so that I can send data to Azure Data Lake Storage Gen2.
@@ -37,6 +37,26 @@ Then, assign a role to the managed identity that grants permission to write to t
3737

3838
Finally, create the *DataflowEndpoint* resource and specify the managed identity authentication method. Replace the placeholder values like `<ENDPOINT_NAME>` with your own.
3939

40+
# [Portal](#tab/portal)
41+
42+
1. In the IoT Operations portal, select the **Dataflow endpoints** tab.
43+
1. Under **Create new dataflow endpoint**, select **Azure Data Lake Storage (2nd generation)** > **New**.
44+
45+
:::image type="content" source="media/howto-configure-adlsv2-endpoint/create-adls-endpoint.png" alt-text="Screenshot using operations experience to create a new ADLS V2 dataflow endpoint.":::
46+
47+
1. Enter the following settings for the endpoint:
48+
49+
| Setting | Description |
50+
| --------------------- | ------------------------------------------------------------------------------------------------- |
51+
| Name | The name of the dataflow endpoint. |
52+
| 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. |
53+
| Authentication method | The method used for authentication. Choose *System assigned managed identity*, *User assigned managed identity*, or *Access token*. |
54+
| Client ID | The client ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
55+
| Tenant ID | The tenant ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
56+
| Access token secret name | The name of the Kubernetes secret containing the SAS token. Required if using *Access token*. |
57+
58+
1. Select **Apply** to provision the endpoint.
59+
4060
# [Bicep](#tab/bicep)
4161

4262
Create a Bicep `.bicep` file with the following content.
@@ -47,13 +67,13 @@ param customLocationName string = '<CUSTOM_LOCATION_NAME>'
4767
param endpointName string = '<ENDPOINT_NAME>'
4868
param host string = 'https://<ACCOUNT>.blob.core.windows.net'
4969
50-
resource aioInstance 'Microsoft.IoTOperations/instances@2024-08-15-preview' existing = {
70+
resource aioInstance 'Microsoft.IoTOperations/instances@2024-09-15-preview' existing = {
5171
name: aioInstanceName
5272
}
5373
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
5474
name: customLocationName
5575
}
56-
resource adlsGen2Endpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-08-15-preview' = {
76+
resource adlsGen2Endpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-09-15-preview' = {
5777
parent: aioInstance
5878
name: endpointName
5979
extendedLocation: {
@@ -112,7 +132,15 @@ If you need to override the system-assigned managed identity audience, see the [
112132

113133
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.
114134

115-
Then, create the *DataflowEndpoint* resource and specify the access token authentication method. Here, replace `<SAS_SECRET_NAME>` with name of the secret containing the SAS token as well as other placeholder values.
135+
Then, create the *DataflowEndpoint* resource and specify the access token authentication method. Here, replace `<SAS_SECRET_NAME>` with name of the secret containing the SAS token and other placeholder values.
136+
137+
# [Portal](#tab/portal)
138+
139+
1. In the Azure IoT Operations Preview portal, create a new dataflow or edit an existing dataflow by selecting the **Dataflows** tab. If creating a new dataflow, select a source for the dataflow.
140+
1. In the editor, select the destination dataflow endpoint.
141+
1. Choose the Azure Data Lake Storage Gen2 endpoint that you created previously.
142+
143+
:::image type="content" source="media/howto-configure-adlsv2-endpoint/dataflow-mq-adls.png" alt-text="Screenshot using operations experience to create a dataflow with an MQTT source and ADLS V2 destination.":::
116144

117145
# [Bicep](#tab/bicep)
118146

@@ -124,13 +152,13 @@ param customLocationName string = '<CUSTOM_LOCATION_NAME>'
124152
param endpointName string = '<ENDPOINT_NAME>'
125153
param host string = 'https://<ACCOUNT>.blob.core.windows.net'
126154
127-
resource aioInstance 'Microsoft.IoTOperations/instances@2024-08-15-preview' existing = {
155+
resource aioInstance 'Microsoft.IoTOperations/instances@2024-09-15-preview' existing = {
128156
name: aioInstanceName
129157
}
130158
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
131159
name: customLocationName
132160
}
133-
resource adlsGen2Endpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-08-15-preview' = {
161+
resource adlsGen2Endpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-09-15-preview' = {
134162
parent: aioInstance
135163
name: endpointName
136164
extendedLocation: {
@@ -199,6 +227,12 @@ Before creating the dataflow endpoint, assign a role to the managed identity tha
199227

200228
To use system-assigned managed identity, specify the managed identity authentication method in the *DataflowEndpoint* resource. In most cases, you don't need to specify other settings. Not specifying an audience creates a managed identity with the default audience scoped to your storage account.
201229

230+
# [Portal](#tab/portal)
231+
232+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **System assigned managed identity**.
233+
234+
In most cases, you don't need to specify a service audience. Not specifying an audience creates a managed identity with the default audience scoped to your storage account.
235+
202236
# [Bicep](#tab/bicep)
203237

204238
```bicep
@@ -223,6 +257,10 @@ dataLakeStorageSettings:
223257
224258
If you need to override the system-assigned managed identity audience, you can specify the `audience` setting.
225259

260+
# [Portal](#tab/portal)
261+
262+
In most cases, you don't need to specify a service audience. Not specifying an audience creates a managed identity with the default audience scoped to your storage account.
263+
226264
# [Bicep](#tab/bicep)
227265

228266
```bicep
@@ -274,6 +312,12 @@ You can also use the IoT Operations portal to create and manage the secret. To l
274312

275313
Finally, create the *DataflowEndpoint* resource with the secret reference.
276314

315+
# [Portal](#tab/portal)
316+
317+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **Access token**.
318+
319+
Enter the access token secret name you created in **Access token secret name**.
320+
277321
# [Bicep](#tab/bicep)
278322

279323
```bicep
@@ -303,6 +347,12 @@ dataLakeStorageSettings:
303347

304348
To use a user-assigned managed identity, specify the `UserAssignedManagedIdentity` authentication method and provide the `clientId` and `tenantId` of the managed identity.
305349

350+
# [Portal](#tab/portal)
351+
352+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **User assigned managed identity**.
353+
354+
Enter the user assigned managed identity client ID and tenant ID in the appropriate fields.
355+
306356
# [Bicep](#tab/bicep)
307357

308358
```bicep
@@ -343,6 +393,12 @@ Use the `batching` settings to configure the maximum number of messages and the
343393

344394
For example, to configure the maximum number of messages to 1000 and the maximum latency to 100 seconds, use the following settings:
345395

396+
# [Portal](#tab/portal)
397+
398+
In the operations experience, select the **Advanced** tab for the dataflow endpoint.
399+
400+
:::image type="content" source="media/howto-configure-adlsv2-endpoint/adls-advanced.png" alt-text="Screenshot using operations experience to set ADLS V2 advanced settings.":::
401+
346402
# [Bicep](#tab/bicep)
347403

348404
```bicep
@@ -368,4 +424,4 @@ fabricOneLakeSettings:
368424

369425
## Next steps
370426

371-
- [Create a dataflow](howto-create-dataflow.md)
427+
To learn more about dataflows, see [Create a dataflow](howto-create-dataflow.md).

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

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,23 @@ To send data to Azure Data Explorer in Azure IoT Operations Preview, you can con
5959
6060
Create the dataflow endpoint resource with your cluster and database information. We suggest using the managed identity of the Azure Arc-enabled Kubernetes cluster. This approach is secure and eliminates the need for secret management. Replace the placeholder values like `<ENDPOINT_NAME>` with your own.
6161
62+
# [Portal](#tab/portal)
63+
64+
1. In the operations experience, select the **Dataflow endpoints** tab.
65+
1. Under **Create new dataflow endpoint**, select **Azure Data Explorer** > **New**.
66+
67+
:::image type="content" source="media/howto-configure-adx-endpoint/create-adx-endpoint.png" alt-text="Screenshot using operations experience to create an Azure Data Explorer dataflow endpoint.":::
68+
69+
1. Enter the following settings for the endpoint:
70+
71+
| Setting | Description |
72+
| --------------------- | ------------------------------------------------------------------------------------------------- |
73+
| Name | The name of the dataflow endpoint. |
74+
| Host | The hostname of the Azure Data Explorer endpoint in the format `<cluster>.<region>.kusto.windows.net`. |
75+
| Authentication method | The method used for authentication. Choose *System assigned managed identity* or *User assigned managed identity* |
76+
| Client ID | The client ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
77+
| Tenant ID | The tenant ID of the user-assigned managed identity. Required if using *User assigned managed identity*. |
78+
6279
# [Bicep](#tab/bicep)
6380
6481
Create a Bicep `.bicep` file with the following content.
@@ -70,13 +87,13 @@ param endpointName string = '<ENDPOINT_NAME>'
7087
param hostName string = 'https://<CLUSTER>.<region>.kusto.windows.net'
7188
param databaseName string = '<DATABASE_NAME>'
7289
73-
resource aioInstance 'Microsoft.IoTOperations/instances@2024-08-15-preview' existing = {
90+
resource aioInstance 'Microsoft.IoTOperations/instances@2024-09-15-preview' existing = {
7491
name: aioInstanceName
7592
}
7693
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
7794
name: customLocationName
7895
}
79-
resource adxEndpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-08-15-preview' = {
96+
resource adxEndpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-09-15-preview' = {
8097
parent: aioInstance
8198
name: endpointName
8299
extendedLocation: {
@@ -143,6 +160,10 @@ Before you create the dataflow endpoint, assign a role to the managed identity t
143160

144161
In the *DataflowEndpoint* resource, specify the managed identity authentication method. In most cases, you don't need to specify other settings. This configuration creates a managed identity with the default audience `https://api.kusto.windows.net`.
145162

163+
# [Portal](#tab/portal)
164+
165+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **System assigned managed identity**.
166+
146167
# [Bicep](#tab/bicep)
147168

148169
```bicep
@@ -167,6 +188,11 @@ dataExplorerSettings:
167188
168189
If you need to override the system-assigned managed identity audience, you can specify the `audience` setting.
169190

191+
192+
# [Portal](#tab/portal)
193+
194+
In most cases, you don't need to specify a service audience. Not specifying an audience creates a managed identity with the default audience scoped to your storage account.
195+
170196
# [Bicep](#tab/bicep)
171197

172198
```bicep
@@ -196,6 +222,12 @@ dataExplorerSettings:
196222

197223
To use a user-assigned managed identity, specify the `UserAssignedManagedIdentity` authentication method and provide the `clientId` and `tenantId` of the managed identity.
198224

225+
# [Portal](#tab/portal)
226+
227+
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **User assigned managed identity**.
228+
229+
Enter the user assigned managed identity client ID and tenant ID in the appropriate fields.
230+
199231
# [Bicep](#tab/bicep)
200232

201233
```bicep
@@ -236,6 +268,12 @@ Use the `batching` settings to configure the maximum number of messages and the
236268

237269
For example, to configure the maximum number of messages to 1000 and the maximum latency to 100 seconds, use the following settings:
238270

271+
# [Portal](#tab/portal)
272+
273+
In the operations experience, select the **Advanced** tab for the dataflow endpoint.
274+
275+
:::image type="content" source="media/howto-configure-adx-endpoint/adx-advanced.png" alt-text="Screenshot using operations experience to set Azure Data Explorer advanced settings.":::
276+
239277
# [Bicep](#tab/bicep)
240278

241279
```bicep
@@ -260,4 +298,4 @@ dataExplorerSettings:
260298

261299
## Next steps
262300

263-
- [Create a dataflow](howto-create-dataflow.md)
301+
To learn more about dataflows, see [Create a dataflow](howto-create-dataflow.md).

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,10 @@ Similar to the MQTT example, you can create multiple dataflows that use the same
9797
9898
## Next steps
9999
100-
- Create a dataflow endpoint:
101-
- [MQTT or Event Grid](howto-configure-mqtt-endpoint.md)
102-
- [Kafka or Event Hubs](howto-configure-kafka-endpoint.md)
103-
- [Data Lake](howto-configure-adlsv2-endpoint.md)
104-
- [Microsoft Fabric OneLake](howto-configure-fabric-endpoint.md)
105-
- [Local storage](howto-configure-local-storage-endpoint.md)
100+
Create a dataflow endpoint:
101+
102+
- [MQTT or Event Grid](howto-configure-mqtt-endpoint.md)
103+
- [Kafka or Event Hubs](howto-configure-kafka-endpoint.md)
104+
- [Data Lake](howto-configure-adlsv2-endpoint.md)
105+
- [Microsoft Fabric OneLake](howto-configure-fabric-endpoint.md)
106+
- [Local storage](howto-configure-local-storage-endpoint.md)

articles/iot-operations/connect-to-cloud/howto-configure-dataflow-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ spec:
6767

6868
## Next steps
6969

70-
- [Create a dataflow](howto-create-dataflow.md)
70+
To learn more about dataflows, see [Create a dataflow](howto-create-dataflow.md).

0 commit comments

Comments
 (0)