Share via

az iot ops dataflow profile

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

Dataflow profile management.

Commands

Name Description Type Status
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 profile create

Create or replace a dataflow profile.

az iot ops dataflow profile create --instance
                                   --name
                                   --resource-group
                                   [--log-level]
                                   [--profile-instances]

Examples

Create a dataflow profile in the instance 'mycluster-ops-instance' with default properties.

az iot ops dataflow profile create -n myprofile --in mycluster-ops-instance -g myresourcegroup

Create a dataflow profile in the instance 'mycluster-ops-instance' with 2 profile instances.

az iot ops dataflow profile create -n myprofile --in mycluster-ops-instance -g myresourcegroup --profile-instances 2

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow profile name.

--resource-group -g

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

Optional Parameters

--log-level

The level of detail given in diagnostic logs. Levels: 'error', 'warn', 'info', 'debug', 'trace', 'off'. For advanced usage you can specify a comma-separated list of module=level pairs.

Default value: info
--profile-instances

The number of pods that run associated dataflows. Min value: 1, max value: 20.

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

Delete a dataflow profile.

Deleting a dataflow profile will also delete associated dataflows.

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

Examples

Delete the dataflow profile 'myprofile' in the instance 'mycluster-ops-instance'.

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

Skip the delete confirmation prompt while deleting the dataflow profile 'myprofile' in the instance 'mycluster-ops-instance'.

az iot ops dataflow profile delete -n myprofile --in mycluster-ops-instance -g myresourcegroup -y

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

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

List dataflow profiles associated with an instance.

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

Examples

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

az iot ops dataflow profile 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 profile show

Show details of a dataflow profile.

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

Examples

Show details of a dataflow profile 'myprofile'.

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

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

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 profile update

Update a dataflow profile.

az iot ops dataflow profile update --instance
                                   --name
                                   --resource-group
                                   [--log-level]
                                   [--profile-instances]

Examples

Update the log level of the dataflow profile 'myprofile' to 'debug'.

az iot ops dataflow profile update -n myprofile --in mycluster-ops-instance -g myresourcegroup --log-level debug

Required Parameters

--instance -i

IoT Operations instance name.

--name -n

Dataflow profile name.

--resource-group -g

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

Optional Parameters

--log-level

The level of detail given in diagnostic logs. Levels: 'error', 'warn', 'info', 'debug', 'trace', 'off'. For advanced usage you can specify a comma-separated list of module=level pairs.

--profile-instances

The number of pods that run associated dataflows. Min value: 1, max value: 20.

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.