az iot ops dataflow

Note

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

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Dataflow management.

Commands

Name	Description	Type	Status
az iot ops dataflow endpoint	Dataflow endpoint management.	Extension	Preview
az iot ops dataflow endpoint list	List dataflow endpoint resources associated with an instance.	Extension	Preview
az iot ops dataflow endpoint show	Show details of a dataflow endpoint resource.	Extension	Preview
az iot ops dataflow list	List dataflows associated with a dataflow profile.	Extension	Preview
az iot ops dataflow profile	Dataflow profile management.	Extension	Preview
az iot ops dataflow profile list	List dataflow profiles associated with an instance.	Extension	Preview
az iot ops dataflow profile show	Show details of a dataflow profile.	Extension	Preview
az iot ops dataflow show	Show details of a dataflow associated with a dataflow profile.	Extension	Preview

az iot ops dataflow list

Preview

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List dataflows associated with a dataflow profile.

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

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.

--profile -p

Dataflow profile 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 show

Preview

Command group 'iot ops' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a dataflow associated with a dataflow profile.

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

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.

--profile -p

Dataflow profile 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.