Merge pull request #301613 from dominicbetts/patricka-dataflow-cli

Add CLI to IoT Operations data flows

Author: v-ccolin

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

@@ -6,7 +6,7 @@ ms.author: patricka
 ms.service: azure-iot-operations
 ms.subservice: azure-data-flows
 ms.topic: how-to
-ms.date: 04/03/2025
+ms.date: 06/12/2025
 ai-usage: ai-assisted
 
 #CustomerIntent: As an operator, I want to understand how to configure data flow endpoints for Azure Data Explorer in Azure IoT Operations so that I can send data to Azure Data Explorer.
@@ -63,8 +63,6 @@ If using system-assigned managed identity, in Azure portal, go to your Azure IoT
 
 ## Create data flow endpoint for Azure Data Explorer
 
-<!-- TODO: use the data ingest URI for host? -->
-
 # [Operations experience](#tab/portal)
 
 1. In the operations experience, select the **Data flow endpoints** tab.
@@ -84,6 +82,60 @@ If using system-assigned managed identity, in Azure portal, go to your Azure IoT
 
 1. Select **Apply** to provision the endpoint.
 
+# [Azure CLI](#tab/cli)
+
+#### Create or replace
+
+Use the [az iot ops dataflow endpoint create adls](/cli/azure/iot/ops/dataflow/endpoint/create#az-iot-ops-dataflow-endpoint-create-adx) command to create or replace an Azure Data Explorer data flow endpoint.
+
+```azurecli
+az iot ops dataflow endpoint create adx --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --host <ClusterName> --database <DatabaseName>
+```
+
+The `--host` parameter is the hostname of the Azure Data Explorer cluster in the format `<cluster>.<region>.kusto.windows.net`. The `--database` parameter is the name of the Azure Data Explorer database.
+
+Here's an example command to create or replace an Azure Data Explorer data flow endpoint named adx-endpoint:
+
+```azurecli
+az iot ops dataflow endpoint create adx --resource-group myResourceGroup --instance myAioInstance --name adx-endpoint --host myadxcluster.eastus.kusto.windows.net --database mydatabase
+```
+
+#### Create or change
+
+Use the [az iot ops dataflow endpoint apply](/cli/azure/iot/ops/dataflow/endpoint#az-iot-ops-dataflow-endpoint-apply) command to create or change an Azure Data Explorer data flow endpoint.
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --config-file <ConfigFilePathAndName>
+```
+
+The `--config-file` parameter is the path and file name of a JSON configuration file containing the resource properties.
+
+In this example, assume a configuration file named `adx-endpoint.json` with the following content stored in the user's home directory:
+
+```json
+{
+  "endpointType": "DataExplorer",
+  "dataExplorerSettings": {
+    "authentication": {
+      "method": "SystemAssignedManagedIdentity",
+      "systemAssignedManagedIdentitySettings": {}
+    },
+    "batching": {
+      "latencySeconds": 60,
+      "maxMessages": 100000
+    },
+    "host": "https://<cluster>.<region>.kusto.windows.net",
+    "database": "<DatabaseName>"
+  }
+}
+```
+
+Here's an example command to create a new Azure Data Explorer data flow endpoint named adx-endpoint:
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group myResourceGroupName --instance myAioInstanceName --name adx-endpoint --config-file ~/adx-endpoint.json
+```
+
 # [Bicep](#tab/bicep)
 
 Create a Bicep `.bicep` file with the following content.
@@ -92,7 +144,7 @@ Create a Bicep `.bicep` file with the following content.
 param aioInstanceName string = '<AIO_INSTANCE_NAME>'
 param customLocationName string = '<CUSTOM_LOCATION_NAME>'
 param endpointName string = '<ENDPOINT_NAME>'
-param hostName string = 'https://<CLUSTER>.<region>.kusto.windows.net'
+param hostName string = 'https://<cluster>.<region>.kusto.windows.net'
 param databaseName string = '<DATABASE_NAME>'
 
 resource aioInstance 'Microsoft.IoTOperations/instances@2024-11-01' existing = {
@@ -141,7 +193,7 @@ metadata:
 spec:
   endpointType: DataExplorer
   dataExplorerSettings:
-    host: 'https://<CLUSTER>.<region>.kusto.windows.net'
+    host: 'https://<cluster>.<region>.kusto.windows.net'
     database: <DATABASE_NAME>
     authentication:
       # See available authentication methods section for method types
@@ -176,6 +228,60 @@ Then, configure the data flow endpoint with system-assigned managed identity set
 
 In the operations experience data flow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **System assigned managed identity**.
 
+# [Azure CLI](#tab/cli)
+
+#### Create or replace
+
+Use the [az iot ops dataflow endpoint create adls](/cli/azure/iot/ops/dataflow/endpoint/create#az-iot-ops-dataflow-endpoint-create-adx) command to create or replace an Azure Data Explorer data flow endpoint.
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type SystemAssignedManagedIdentity --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --host <ClusterName> --database <DatabaseName>
+```
+
+The `--host` parameter is the hostname of the Azure Data Explorer cluster in the format `<cluster>.<region>.kusto.windows.net`. The `--database` parameter is the name of the Azure Data Explorer database.
+
+Here's an example command to create or replace an Azure Data Explorer data flow endpoint named adx-endpoint:
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type SystemAssignedManagedIdentity --resource-group myResourceGroup --instance myAioInstance --name adx-endpoint --host myadxcluster.eastus.kusto.windows.net --database mydatabase
+```
+
+#### Create or change
+
+Use the [az iot ops dataflow endpoint apply](/cli/azure/iot/ops/dataflow/endpoint#az-iot-ops-dataflow-endpoint-apply) command to create or change an Azure Data Explorer data flow endpoint.
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --config-file <ConfigFilePathAndName>
+```
+
+The `--config-file` parameter is the path and file name of a JSON configuration file containing the resource properties.
+
+In this example, assume a configuration file named `adx-endpoint.json` with the following content stored in the user's home directory:
+
+```json
+{
+  "endpointType": "DataExplorer",
+  "dataExplorerSettings": {
+    "authentication": {
+      "method": "SystemAssignedManagedIdentity",
+      "systemAssignedManagedIdentitySettings": {}
+    },
+    "batching": {
+      "latencySeconds": 60,
+      "maxMessages": 100000
+    },
+    "host": "https://<cluster>.<region>.kusto.windows.net",
+    "database": "<DatabaseName>"
+  }
+}
+```
+
+Here's an example command to create a new Azure Data Explorer data flow endpoint named adx-endpoint:
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group myResourceGroupName --instance myAioInstanceName --name adx-endpoint --config-file ~/adx-endpoint.json
+```
+
 # [Bicep](#tab/bicep)
 
 ```bicep
@@ -205,6 +311,62 @@ If you need to override the system-assigned managed identity audience, you can s
 
 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`.
 
+# [Azure CLI](#tab/cli)
+
+#### Create or replace
+
+Use the [az iot ops dataflow endpoint create adls](/cli/azure/iot/ops/dataflow/endpoint/create#az-iot-ops-dataflow-endpoint-create-adx) command to create or replace an Azure Data Explorer data flow endpoint with system-assigned managed identity.
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type SystemAssignedManagedIdentity --audience https://<cluster>.<region>.kusto.windows.net --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --host <cluster>.<region>.kusto.windows.net --database <DatabaseName>
+```
+
+The `--host` parameter is the hostname of the Azure Data Explorer cluster in the format `<cluster>.<region>.kusto.windows.net`. The `--database` parameter is the name of the Azure Data Explorer database. The `--audience` parameter is the audience URL for the managed identity to authenticate against Azure Data Explorer.
+
+Here's an example command to create or replace an Azure Data Explorer data flow endpoint named `adx-endpoint`:
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type SystemAssignedManagedIdentity --audience https://myadxcluster.eastus.kusto.windows.net --resource-group myResourceGroup --instance myAioInstance --name adx-endpoint --host myadxcluster.eastus.kusto.windows.net --database mydatabase
+```
+
+#### Create or change
+
+Use the [az iot ops dataflow endpoint apply](/cli/azure/iot/ops/dataflow/endpoint#az-iot-ops-dataflow-endpoint-apply) command to create or change an Azure Data Explorer data flow endpoint with system-assigned managed identity.
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --config-file <ConfigFilePathAndName>
+```
+
+The `--config-file` parameter is the path and file name of a JSON configuration file containing the resource properties.
+
+In this example, assume a configuration file named `adx-endpoint.json` with the following content stored in the user's home directory:
+
+```json
+{
+  "endpointType": "DataExplorer",
+  "dataExplorerSettings": {
+    "authentication": {
+      "method": "SystemAssignedManagedIdentity",
+      "systemAssignedManagedIdentitySettings": {
+        "audience": "https://<cluster>.<region>.kusto.windows.net"
+      }
+    },
+    "batching": {
+      "latencySeconds": 60,
+      "maxMessages": 100000
+    },
+    "host": "https://<cluster>.<region>.kusto.windows.net",
+    "database": "<DatabaseName>"
+  }
+}
+```
+
+Here's an example command to create a new Azure Data Explorer data flow endpoint named `adx-endpoint`:
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group myResourceGroupName --instance myAioInstanceName --name adx-endpoint --config-file ~/adx-endpoint.json
+```
+
 # [Bicep](#tab/bicep)
 
 ```bicep
@@ -248,6 +410,64 @@ In the operations experience data flow endpoint settings page, select the **Basi
 
 Enter the user assigned managed identity client ID and tenant ID in the appropriate fields.
 
+# [Azure CLI](#tab/cli)
+
+#### Create or replace
+
+Use the [az iot ops dataflow endpoint create adls](/cli/azure/iot/ops/dataflow/endpoint/create#az-iot-ops-dataflow-endpoint-create-adx) command to create or replace an Azure Data Explorer data flow endpoint with user-assigned managed identity.
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type UserAssignedManagedIdentity --client-id <ClientId> --tenant-id <TenantId> --scope <Scope> --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --host <cluster>.<region>.kusto.windows.net --database <DatabaseName>
+```
+
+The `--host` parameter is the hostname of the Azure Data Explorer cluster in the format `<cluster>.<region>.kusto.windows.net`. The `--database` parameter is the name of the Azure Data Explorer database. The `--auth-type` parameter specifies the authentication method, which is `UserAssignedManagedIdentity` in this case. The `--client-id`, `--tenant-id`, and `--scope` parameters specify the user-assigned managed identity client ID, tenant ID, and scope respectively.
+
+Here's an example command to create or replace an Azure Data Explorer data flow endpoint named `adx-endpoint`:
+
+```azurecli
+az iot ops dataflow endpoint create adx --auth-type UserAssignedManagedIdentity --client-id ClientId --tenant-id TenantId --scope https://api.kusto.windows.net/.default --resource-group myResourceGroup --instance myAioInstance --name adx-endpoint --host myadxcluster.eastus.kusto.windows.net --database mydatabase
+```
+
+#### Create or change
+
+Use the [az iot ops dataflow endpoint apply](/cli/azure/iot/ops/dataflow/endpoint#az-iot-ops-dataflow-endpoint-apply) command to create or change an Azure Data Explorer data flow endpoint with user-assigned managed identity.
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --config-file <ConfigFilePathAndName>
+```
+
+The `--config-file` parameter is the path and file name of a JSON configuration file containing the resource properties.
+
+In this example, assume a configuration file named `adx-endpoint.json` with the following content stored in the user's home directory:
+
+```json
+{
+  "endpointType": "DataExplorer",
+  "dataExplorerSettings": {
+    "authentication": {
+      "method": "UserAssignedManagedIdentity",
+      "userAssignedManagedIdentitySettings": {
+        "clientId": "<ClientId>",
+        "scope": "<Scope>",
+        "tenantId": "<TenantId>"
+      }
+    },
+    "batching": {
+      "latencySeconds": 60,
+      "maxMessages": 100000
+    },
+    "host": "https://<cluster>.<region>.kusto.windows.net",
+    "database": "<DatabaseName>"
+  }
+}
+```
+
+Here's an example command to create a new Azure Data Explorer data flow endpoint named `adx-endpoint`:
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group myResourceGroupName --instance myAioInstanceName --name adx-endpoint --config-file ~/adx-endpoint.json
+```
+
 # [Bicep](#tab/bicep)
 
 ```bicep
@@ -300,6 +520,42 @@ In the operations experience, select the **Advanced** tab for the data flow endp
 
 :::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.":::
 
+# [Azure CLI](#tab/cli)
+
+Use the [az iot ops dataflow endpoint apply](/cli/azure/iot/ops/dataflow/endpoint#az-iot-ops-dataflow-endpoint-apply) command to create or change an Azure Data Explorer data flow endpoint with advanced settings.
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group <ResourceGroupName> --instance <AioInstanceName> --name <EndpointName> --config-file <ConfigFilePathAndName>
+```
+
+The `--config-file` parameter is the path and file name of a JSON configuration file containing the resource properties.
+
+In this example, assume a configuration file named `adx-endpoint.json` with the following content stored in the user's home directory:
+
+```json
+{
+  "endpointType": "DataExplorer",
+  "dataExplorerSettings": {
+    "authentication": {
+      "method": "SystemAssignedManagedIdentity",
+      "systemAssignedManagedIdentitySettings": {}
+    },
+    "batching": {
+      "latencySeconds": 100,
+      "maxMessages": 1000
+    },
+    "host": "https://<cluster>.<region>.kusto.windows.net",
+    "database": "<DatabaseName>"
+  }
+}
+```
+
+Here's an example command to create a new Azure Data Explorer data flow endpoint named adx-endpoint:
+
+```azurecli
+az iot ops dataflow endpoint apply --resource-group myResourceGroupName --instance myAioInstanceName --name adx-endpoint --config-file ~/adx-endpoint.json
+```
+
 # [Bicep](#tab/bicep)
 
 ```bicep