Share via

az iot ops dataflow

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 command. Learn more about extensions.

Dataflow management.

Commands

Name Description Type Status
az iot ops dataflow apply

Create or replace a dataflow associated with a dataflow profile.

 Extension GA
az iot ops dataflow delete

Delete a dataflow associated with a dataflow profile.

 Extension GA
az iot ops dataflow endpoint

Dataflow endpoint management.

 Extension GA
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 list

List dataflows associated with a dataflow profile.

 Extension GA
az iot ops dataflow profile

Dataflow profile management.

 Extension GA
az iot ops dataflow profile create

Create or replace a dataflow profile.

 Extension GA
az iot ops dataflow profile delete

Delete a dataflow profile.

 Extension GA
az iot ops dataflow profile list

List dataflow profiles associated with an instance.

 Extension GA
az iot ops dataflow profile show

Show details of a dataflow profile.

 Extension GA
az iot ops dataflow profile update

Update a dataflow profile.

 Extension GA
az iot ops dataflow show

Show details of a dataflow associated with a dataflow profile.

 Extension GA

az iot ops dataflow apply

Create or replace a dataflow associated with a dataflow profile.

An example of the config file format is as follows:

{
  "mode": "Enabled",
  "operations": [
    {
      "operationType": "Source",
      "sourceSettings": {
        "endpointRef": "myenpoint1",
        "assetRef": "",
        "serializationFormat": "Json",
        "schemaRef": "myschema1",
        "dataSources": [
          "testfrom"
        ]
      }
    },
    {
      "operationType": "BuiltInTransformation",
      "builtInTransformationSettings": {
        "serializationFormat": "Json",
        "datasets": [],
        "filter": [
          {
            "type": "Filter",
            "description": "",
            "inputs": [
              "$metadata.user_property.value"
            ],
            "expression": "$1 > 100"
          }
        ],
        "map": [
          {
            "type": "PassThrough",
            "inputs": [
              "*"
            ],
            "output": "*"
          }
        ]
      }
    },
    {
      "operationType": "Destination",
      "destinationSettings": {
        "endpointRef": "myenpoint2",
        "dataDestination": "test"
      }
    }
  ]
}

When used with apply the above content will create or replace a target dataflow resource.

az iot ops dataflow apply --config-file
                          --instance
                          --name
                          --resource-group
                          [--profile]

Examples

Create or replace a dataflow 'mydataflow' associated with a profile 'myprofile' using a config file.

az iot ops dataflow apply -n mydataflow -p myprofile --in myinstance -g myresourcegroup --config-file /path/to/dataflow/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 name.

--resource-group -g

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

Optional Parameters

--profile -p

Dataflow profile name.

Default value: default
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 delete

Delete a dataflow associated with a dataflow profile.

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

Examples

Delete a dataflow 'mydataflow' associated with a profile 'myprofile'.

az iot ops dataflow delete -n mydataflow -p myprofile --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow name.

--resource-group -g

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

Optional Parameters

--profile -p

Dataflow profile name.

Default value: default
--yes -y

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

Accepted values: false, true
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 list

List dataflows associated with a dataflow profile.

az iot ops dataflow list --instance
                         --resource-group
                         [--profile]

Examples

Enumerate dataflows associated with the profile 'myprofile'.

az iot ops dataflow list -p myprofile --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>.

Optional Parameters

--profile -p

Dataflow profile name.

Default value: default
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 show

Show details of a dataflow associated with a dataflow profile.

az iot ops dataflow show --instance
                         --name
                         --resource-group
                         [--profile]

Examples

Show details of a dataflow 'mydataflow' associated with a profile 'myprofile'.

az iot ops dataflow show -n mydataflow -p myprofile --in mycluster-ops-instance -g myresourcegroup

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow name.

--resource-group -g

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

Optional Parameters

--profile -p

Dataflow profile name.

Default value: default
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.