Share via

az iot ops dataflow endpoint

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az iot ops dataflow endpoint command. Learn more about extensions.

Dataflow endpoint management.

Commands

Name Description Type Status
az iot ops dataflow endpoint apply

Create or replace a dataflow endpoint resource.

 Extension GA
az iot ops dataflow endpoint create

Create or replace a dataflow endpoint resource.

 Extension GA
az iot ops dataflow endpoint create adls

Create or replace a dataflow endpoint resource for Azure Data Lake Storage Gen2.

 Extension GA
az iot ops dataflow endpoint create adx

Create or replace a dataflow endpoint resource for Azure Data Explorer.

 Extension GA
az iot ops dataflow endpoint create custom-kafka

Create or replace a dataflow endpoint resource for custom kafka broker.

 Extension GA
az iot ops dataflow endpoint create custom-mqtt

Create or replace a dataflow endpoint resource for custom MQTT broker.

 Extension GA
az iot ops dataflow endpoint create eventgrid

Create or replace a dataflow endpoint resource for Azure Event Grid.

 Extension GA
az iot ops dataflow endpoint create eventhub

Create or replace a dataflow endpoint resource for kafka-enabled Azure Event Hubs namespace.

 Extension GA
az iot ops dataflow endpoint create fabric-onelake

Create or replace a dataflow endpoint resource for Microsoft Fabric OneLake.

 Extension GA
az iot ops dataflow endpoint create fabric-realtime

Create or replace a Microsoft Fabric Real-Time Intelligence data flow endpoint.

 Extension GA
az iot ops dataflow endpoint create local-mqtt

Create or replace a Azure IoT Operations Local MQTT dataflow endpoint.

 Extension GA
az iot ops dataflow endpoint create local-storage

Create or replace a local storage dataflow endpoint.

 Extension GA
az iot ops dataflow endpoint delete

Delete a dataflow endpoint resource.

 Extension GA
az iot ops dataflow endpoint list

List dataflow endpoint resources associated with an instance.

 Extension GA
az iot ops dataflow endpoint show

Show details of a dataflow endpoint resource.

 Extension GA
az iot ops dataflow endpoint update

Update the properties of an existing dataflow endpoint resource.

 Extension GA
az iot ops dataflow endpoint update adls

Update the properties of an existing dataflow endpoint resource for Azure Data Lake Storage Gen2.

 Extension GA
az iot ops dataflow endpoint update adx

Update the properties of an existing dataflow endpoint resource for Azure Data Explorer.

 Extension GA
az iot ops dataflow endpoint update custom-kafka

Update the properties of an existing dataflow endpoint resource for custom kafka broker.

 Extension GA
az iot ops dataflow endpoint update custom-mqtt

Update the properties of an existing dataflow endpoint resource for custom MQTT broker.

 Extension GA
az iot ops dataflow endpoint update eventgrid

Update the properties of an existing dataflow endpoint resource for Azure Event Grid.

 Extension GA
az iot ops dataflow endpoint update eventhub

Update the properties of an existing dataflow endpoint resource for kafka-enabled Azure Event Hubs namespace.

 Extension GA
az iot ops dataflow endpoint update fabric-onelake

Update the properties of an existing dataflow endpoint resource for Microsoft Fabric OneLake.

 Extension GA
az iot ops dataflow endpoint update fabric-realtime

Update the properties of an existing Microsoft Fabric Real-Time Intelligence data flow endpoint.

 Extension GA
az iot ops dataflow endpoint update local-mqtt

Update the properties of an existing Azure IoT Operations Local MQTT data flow endpoint.

 Extension GA
az iot ops dataflow endpoint update local-storage

Update the properties of an existing local storage data flow endpoint.

 Extension GA

az iot ops dataflow endpoint apply

Create or replace a dataflow endpoint resource.

An example of the config file format is as follows:

{
  "endpointType": "Kafka",
  "kafkaSettings": {
    "authentication": {
      "method": "SystemAssignedManagedIdentity",
      "systemAssignedManagedIdentitySettings": {
        "audience": "aio-internal"
      }
    },
    "batching": {
      "latencyMs": 5,
      "maxBytes": 1000000,
      "maxMessages": 100000,
      "mode": "Enabled"
    },
    "cloudEventAttributes": "Propagate",
    "compression": "None",
    "copyMqttProperties": "Disabled",
    "host": "test.servicebus.windows.net:9093",
    "kafkaAcks": "All",
    "partitionStrategy": "Default",
    "tls": {
      "mode": "Enabled"
    }
  },
}

When used with apply the above content will create or replace a target kafka dataflow endpoint resource configured with system assigned managed identity authentication method.

az iot ops dataflow endpoint apply --config-file
                                   --instance
                                   --name
                                   --resource-group

Examples

Create or replace an dataflow endpoint resource using a config file.

az iot ops dataflow endpoint apply -n dataflowep --in myinstance -g myresourcegroup --config-file /path/to/dataflowep/config.json

Required Parameters

--config-file

Path to a config file containing resource properties in json format. The config file should contain an object with properties compatible with the ARM representation of the resource. The object correlates directly with 'properties:{}' of the ARM resource.

--instance -i

IoT Operations instance name.

--name -n

Dataflow endpoint name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot ops dataflow endpoint delete

Delete a dataflow endpoint resource.

az iot ops dataflow endpoint delete --instance
                                    --name
                                    --resource-group
                                    [--yes {false, true}]

Examples

Delete the dataflow endpoint resource called 'dataflowep'.

az iot ops dataflow endpoint delete -n dataflowep --in myinstance -g myresourcegroup

Same as prior example but skipping the confirmation prompt.

az iot ops dataflow endpoint delete -n dataflowep --in myinstance -g myresourcegroup -y

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow endpoint name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--yes -y

Confirm [y]es without a prompt. Useful for CI and automation scenarios.

Accepted values: false, true
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot ops dataflow endpoint list

List dataflow endpoint resources associated with an instance.

az iot ops dataflow endpoint list --instance
                                  --resource-group

Examples

Enumerate dataflow endpoints in the instance 'mycluster-ops-instance'.

az iot ops dataflow endpoint list --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--instance -i

IoT Operations instance name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot ops dataflow endpoint show

Show details of a dataflow endpoint resource.

az iot ops dataflow endpoint show --instance
                                  --name
                                  --resource-group

Examples

Show details of a dataflow endpoint 'myendpoint'.

az iot ops dataflow endpoint show -n myendpoint --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow endpoint name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.