Share via

az iot ops ns asset opcua dataset

  • Preview

Note

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

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

Manage datasets for OPC UA namespaced assets in an IoT Operations instance.

Currently, only one dataset with the name "default" is supported for assets.

Commands

Name Description Type Status
az iot ops ns asset opcua dataset add

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

 Extension Preview
az iot ops ns asset opcua dataset list

List datasets for an OPC UA namespaced asset in an IoT Operations instance.

 Extension Preview
az iot ops ns asset opcua dataset point

Manage data points for OPC UA asset datasets in Device Registry namespaces.

 Extension Preview
az iot ops ns asset opcua dataset point add

Add a data point to an OPC UA asset dataset in a Device Registry namespace.

 Extension Preview
az iot ops ns asset opcua dataset point list

List data points for an OPC UA asset dataset in a Device Registry namespace.

 Extension Preview
az iot ops ns asset opcua dataset point remove

Remove a data point from an OPC UA asset dataset in a Device Registry namespace.

 Extension Preview
az iot ops ns asset opcua dataset remove

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

 Extension Preview
az iot ops ns asset opcua dataset show

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

 Extension Preview
az iot ops ns asset opcua dataset update

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

 Extension Preview

az iot ops ns asset opcua dataset add

Preview

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

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

Currently, only one dataset with the name "default" is supported for assets.

az iot ops ns asset opcua dataset add --asset
                                      --data-source --ds
                                      --instance
                                      --name
                                      --resource-group
                                      [--dest --destination]
                                      [--key-frame-count --kfc]
                                      [--pi --publish-int]
                                      [--qs --queue-size]
                                      [--replace {false, true}]
                                      [--sampling-int --si]

Examples

Add a basic OPC UA dataset

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

Add an OPC UA dataset with publishing and sampling intervals

az iot ops ns asset opcua dataset add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name pressureData --data-source "ns=2;s=Pressure" --publish-int 1000 --sampling-int 500 --queue-size 10

Add an OPC UA dataset with key frame count

az iot ops ns asset opcua dataset add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name videoData --data-source "ns=2;s=VideoStream" --key-frame-count 5

Add an OPC UA dataset with MQTT destination

az iot ops ns asset opcua dataset add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData --data-source "ns=2;s=Temperature" --dest topic="factory/opcua/temperature" retain=Keep qos=Qos1 ttl=3600

Add an OPC UA dataset and replace existing one with same name

az iot ops ns asset opcua dataset add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData --data-source "ns=3;s=NewTemperature" --replace

Required Parameters

--asset -a

Asset name.

--data-source --ds

Data source for the dataset.

--instance -i

The name of the Azure IoT Operations instance.

--name

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.

--dest --destination

Key=value pairs representing the destination for datasets. Allowed and required arguments are topic, retain, qos, and ttl for MQTT destinations. Allowed values for retain are Never and Keep and allowed values for qos are Qos0 and Qos1.

--key-frame-count --kfc

Key frame count for datasets. Minimum: 0.

--pi --publish-int

Publishing interval for datasets in milliseconds. Minimum: -1.

--qs --queue-size

Queue size for datasets. Minimum: 0.

--replace

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

Property Value
Default value: False
Accepted values: false, true
--sampling-int --si

Sampling interval for datasets in milliseconds. Minimum: -1.

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 opcua dataset list

Preview

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

List datasets for an OPC UA namespaced asset in an IoT Operations instance.

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

Examples

List all datasets for an OPC UA asset

az iot ops ns asset opcua dataset list --asset myopcuaasset --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 opcua dataset remove

Preview

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

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

az iot ops ns asset opcua dataset remove --asset
                                         --instance
                                         --name
                                         --resource-group

Examples

Remove a dataset from an OPC UA asset

az iot ops ns asset opcua dataset remove --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

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 opcua dataset show

Preview

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

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

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

Examples

Show dataset details

az iot ops ns asset opcua dataset show --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

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 opcua dataset update

Preview

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

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

az iot ops ns asset opcua dataset update --asset
                                         --instance
                                         --name
                                         --resource-group
                                         [--data-source --ds]
                                         [--dest --destination]
                                         [--key-frame-count --kfc]
                                         [--pi --publish-int]
                                         [--qs --queue-size]
                                         [--sampling-int --si]

Examples

Update dataset data source and intervals

az iot ops ns asset opcua dataset update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData --data-source "ns=3;s=UpdatedTemperature" --publish-int 2000 --sampling-int 1000

Update dataset queue size and key frame count

az iot ops ns asset opcua dataset update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name videoData --queue-size 20 --key-frame-count 10

Update dataset destination

az iot ops ns asset opcua dataset update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name temperatureData --dest topic="factory/opcua/updated/temperature" retain=Never qos=Qos0 ttl=7200

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

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.

--data-source --ds

Data source for the dataset.

--dest --destination

Key=value pairs representing the destination for datasets. Allowed and required arguments are topic, retain, qos, and ttl for MQTT destinations. Allowed values for retain are Never and Keep and allowed values for qos are Qos0 and Qos1.

--key-frame-count --kfc

Key frame count for datasets. Minimum: 0.

--pi --publish-int

Publishing interval for datasets in milliseconds. Minimum: -1.

--qs --queue-size

Queue size for datasets. Minimum: 0.

--sampling-int --si

Sampling interval for datasets in milliseconds. Minimum: -1.

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