az iot ops ns asset dataset

Note

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

Manage datasets for namespaced assets in an IoT Operations instance.

The connector type is detected automatically from the existing asset. For connector-specific parameters use --dataset-config (inline JSON or file). Use --show-template to discover the supported configuration schema for the asset's connector type.

Commands

Name	Description	Type	Status
az iot ops ns asset dataset add	Add a dataset to a namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset dataset export	Export datasets to file.	Extension	Preview
az iot ops ns asset dataset import	Import datasets from file.	Extension	Preview
az iot ops ns asset dataset list	List datasets for a namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset dataset remove	Remove a dataset from a namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset dataset show	Show details of a dataset for a namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset dataset update	Update a dataset for a namespaced asset in an IoT Operations instance.	Extension	Preview

az iot ops ns asset dataset add

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a dataset to a namespaced asset in an IoT Operations instance.

The connector type is detected from the asset's device endpoint. Connector-specific configuration (publishing interval, queue size, etc.) can be supplied via --dataset-config. Use --show-template to discover the supported config schema. For non-OPC UA connectors, a connector template must exist in the instance.

az iot ops ns asset dataset add --asset
                                --instance
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--data-source --ds]
                                [--dataset-config --dc]
                                [--replace {false, true}]
                                [--show-template {config, schema}]
                                [--tr --type-ref]

Examples

Add a basic dataset to any asset type

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --data-source "ns=2;s=Temperature"

Show the dataset config template for the asset's connector type

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --show-template config

Add a dataset with connector-specific configuration from inline JSON

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --dataset-config '{"datasetConfiguration": {"publishingInterval": 1000, "samplingInterval": 500}}'

Add a dataset with configuration from a file

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --dataset-config ./dataset_config.json

Add a dataset with an MQTT destination

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --dataset-config '{"destinations": [{"target": "Mqtt", "configuration": {"topic": "factory/data", "retain": "Keep", "qos": "Qos1", "ttl": 3600}}]}'

Replace an existing dataset

az iot ops ns asset dataset add --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --replace

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Dataset name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--data-source --ds

Data source for the dataset.

--dataset-config --dc

Inline JSON string or path to a JSON/YAML file (.json, .yaml, .yml) containing connector-specific dataset configuration and/or destinations. Accepted keys are 'datasetConfiguration' (connector-specific config object) and 'destinations' (list of destination objects). Use --show-template to discover the supported keys and schema for the asset's connector type. Cannot be combined with --show-template. For non-OPC UA connectors, a connector template must exist in the instance.

--replace

Replace the dataset if another dataset with the same name is already present.

Property	Value
Default value:	False
Accepted values:	false, true

--show-template

Show a starter dataset configuration template for the asset's connector type and exit without modifying the dataset. The connector type is read from the existing asset. config: fields shown with their default values (null if no default); output is directly usable as --dataset-config input. schema: every field includes type, default, and constraints (min, max, enum, pattern). Draft-07 $ref pointers (#/definitions/...) are resolved inline in both modes.

Property	Value
Accepted values:	config, schema

--tr --type-ref

Type definition ID or URI.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset export

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Export datasets to file.

az iot ops ns asset dataset export --asset
                                   --instance
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--format {json, yaml}]
                                   [--od --output-dir]
                                   [--replace {false, true}]

Examples

Export datasets to JSON

az iot ops ns asset dataset export --asset myasset --instance myInstance -g myInstanceResourceGroup

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--format -f

Export file format (JSON or YAML).

Property	Value
Default value:	json
Accepted values:	json, yaml

--od --output-dir

Output directory for export.

Property	Value
Default value:	.

--replace

Replace the local file if present.

Property	Value
Default value:	False
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset import

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Import datasets from file.

az iot ops ns asset dataset import --asset
                                   --if --input-file
                                   --instance
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--replace {false, true}]

Examples

Import datasets from a JSON file

az iot ops ns asset dataset import --asset myasset --instance myInstance -g myInstanceResourceGroup --input-file ./datasets.json

Required Parameters

--asset -a

Asset name.

--if --input-file

Path to import file (JSON or YAML).

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--replace

Replace existing datasets that share a name with an imported dataset.

Property	Value
Default value:	False
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List datasets for a namespaced asset in an IoT Operations instance.

az iot ops ns asset dataset list --asset
                                 --instance
                                 --resource-group

Examples

List all datasets for an asset

az iot ops ns asset dataset list --asset myasset --instance myInstance -g myInstanceResourceGroup

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset remove

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a dataset from a namespaced asset in an IoT Operations instance.

az iot ops ns asset dataset remove --asset
                                   --instance
                                   --name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

Examples

Remove a dataset from an asset

az iot ops ns asset dataset remove --asset myasset --instance myInstance -g myInstanceResourceGroup --name default

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Dataset name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a dataset for a namespaced asset in an IoT Operations instance.

az iot ops ns asset dataset show --asset
                                 --instance
                                 --name
                                 --resource-group

Examples

Show dataset details

az iot ops ns asset dataset show --asset myasset --instance myInstance -g myInstanceResourceGroup --name default

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Dataset name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az iot ops ns asset dataset update

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a dataset for a namespaced asset in an IoT Operations instance.

The connector type is detected from the asset's device endpoint. Use --dataset-config to supply connector-specific configuration. Use --show-template config to see current dataset values pre-filled in the full schema structure (ready to edit and pass back via --dataset-config). Use --show-template schema to see the full connector schema with types and constraints.

az iot ops ns asset dataset update --asset
                                   --instance
                                   --name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--data-source --ds]
                                   [--dataset-config --dc]
                                   [--show-template {config, schema}]
                                   [--tr --type-ref]

Examples

Show current dataset config pre-filled with existing values (for editing before update)

az iot ops ns asset dataset update --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --show-template config

Show the dataset config schema with types and constraints

az iot ops ns asset dataset update --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --show-template schema

Update dataset configuration from inline JSON

az iot ops ns asset dataset update --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --dataset-config '{"datasetConfiguration": {"publishingInterval": 2000}}'

Update dataset data source

az iot ops ns asset dataset update --asset myasset --instance myInstance -g myInstanceResourceGroup --name default --data-source "ns=3;s=UpdatedSensor"

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Dataset name.

--resource-group -g

The resource group of the Azure IoT Operations instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--data-source --ds

Data source for the dataset.

--dataset-config --dc

Inline JSON string or path to a JSON/YAML file (.json, .yaml, .yml) containing connector-specific dataset configuration and/or destinations. Accepted keys are 'datasetConfiguration' (connector-specific config object) and 'destinations' (list of destination objects). Use --show-template to discover the supported keys and schema for the asset's connector type. Cannot be combined with --show-template. For non-OPC UA connectors, a connector template must exist in the instance.

--show-template

Show a starter dataset configuration template for the asset's connector type and exit without modifying the dataset. The connector type is read from the existing asset. config: fields shown with their default values (null if no default); output is directly usable as --dataset-config input. schema: every field includes type, default, and constraints (min, max, enum, pattern). Draft-07 $ref pointers (#/definitions/...) are resolved inline in both modes.

Property	Value
Accepted values:	config, schema

--tr --type-ref

Type definition ID or URI.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False