az iot ops ns asset opcua

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 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 namespaced assets that point to OPC UA device endpoints.

For more information on OPC UA connectors, please see https://aka.ms/aio-opcua-quickstart.

Commands

Name	Description	Type	Status
az iot ops ns asset opcua create	Create an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua dataset	Manage datasets for OPC UA namespaced assets in an IoT Operations instance.	Extension	Preview
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 event	Manage events for OPC UA namespaced assets in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua event add	Add an event to an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua event list	List events for an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua event remove	Remove an event from an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua event show	Show details of an event for an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua event update	Update an event for an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua mgmt	Manage OPC UA asset management groups in an IoT Operations instance.	Extension	Preview
az iot ops ns asset opcua mgmt action	Manage actions within OPC UA asset management groups.	Extension	Preview
az iot ops ns asset opcua mgmt action add	Add an action to an OPC UA asset management group.	Extension	Preview
az iot ops ns asset opcua mgmt action list	List actions in an OPC UA asset management group.	Extension	Preview
az iot ops ns asset opcua mgmt action remove	Remove an action from an OPC UA asset management group.	Extension	Preview
az iot ops ns asset opcua mgmt add	Add a management group to an OPC UA asset.	Extension	Preview
az iot ops ns asset opcua mgmt list	List management groups for an OPC UA asset.	Extension	Preview
az iot ops ns asset opcua mgmt remove	Remove a management group from an OPC UA asset.	Extension	Preview
az iot ops ns asset opcua mgmt show	Show details of a management group for an OPC UA asset.	Extension	Preview
az iot ops ns asset opcua mgmt update	Update a management group for an OPC UA asset.	Extension	Preview
az iot ops ns asset opcua update	Update an OPC UA namespaced asset in an IoT Operations instance.	Extension	Preview

az iot ops ns asset opcua create

Preview

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

Create an OPC UA namespaced asset in an IoT Operations instance.

The device endpoint must be of type Microsoft.OpcUa.

az iot ops ns asset opcua create --device
                                 --endpoint --ep
                                 --instance
                                 --name
                                 --resource-group
                                 [--asset-type-ref --type-ref]
                                 [--attr --attribute]
                                 [--dataset-dest --dsd]
                                 [--dataset-key-frame-count --dskfc]
                                 [--dataset-publish-int --dspi]
                                 [--dataset-queue-size --dsqs]
                                 [--dataset-sampling-int --dssi]
                                 [--description]
                                 [--disable {false, true}]
                                 [--display-name --dn]
                                 [--doc-uri --documentation-uri]
                                 [--eid --external-asset-id]
                                 [--evd --event-dest]
                                 [--event-publish-int --evpi]
                                 [--event-queue-size --evqs]
                                 [--hardware-revision --hw-rev]
                                 [--manufacturer]
                                 [--manufacturer-uri --mfr-uri]
                                 [--model]
                                 [--pc --product-code]
                                 [--serial-number --sn]
                                 [--software-revision --sw-rev]
                                 [--tags]

Examples

Create a basic OPC UA asset

az iot ops ns asset opcua create --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --device myOpcuaDevice --endpoint myOpcuaEndpoint

Create an OPC UA asset with dataset configuration

az iot ops ns asset opcua create --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --device myOpcuaDevice --endpoint myOpcuaEndpoint --dataset-publish-int 1000 --dataset-sampling-int 500 --dataset-queue-size 5 --dataset-key-frame-count 1

Create an OPC UA asset with event configuration

az iot ops ns asset opcua create --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --device myOpcuaDevice --endpoint myOpcuaEndpoint --event-publish-int 2000 --event-queue-size 10

Create an OPC UA asset with MQTT destinations for datasets and events

az iot ops ns asset opcua create --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --device myOpcuaDevice --endpoint myOpcuaEndpoint --dataset-dest topic="factory/opcua/data" retain=Keep qos=Qos1 ttl=3600 --event-dest topic="factory/opcua/events" retain=Never qos=Qos1 ttl=3600

Required Parameters

--device -d

Device name.

--endpoint --ep

Device endpoint name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Name of the asset.

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

--asset-type-ref --type-ref

Space-separated list of asset type references.

Property	Value
Parameter group:	Additional Info Arguments

--attr --attribute

Space-separated key=value pairs for custom asset attributes.

Property	Value
Parameter group:	Additional Info Arguments

--dataset-dest --dsd

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.

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-key-frame-count --dskfc

Key frame count for datasets. Minimum: 0.

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-publish-int --dspi

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

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-queue-size --dsqs

Queue size for datasets. Minimum: 0.

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-sampling-int --dssi

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

Property	Value
Parameter group:	Default Dataset Arguments

--description

Description of the asset.

Property	Value
Parameter group:	Additional Info Arguments

--disable

Disable the asset.

Property	Value
Parameter group:	Additional Info Arguments
Accepted values:	false, true

--display-name --dn

Display name for the asset.

Property	Value
Parameter group:	Additional Info Arguments

--doc-uri --documentation-uri

Documentation URI for the asset.

Property	Value
Parameter group:	Additional Info Arguments

--eid --external-asset-id

External asset ID.

Property	Value
Parameter group:	Additional Info Arguments

--evd --event-dest

Key=value pairs representing the destination for events. 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.

Property	Value
Parameter group:	Default Event Arguments

--event-publish-int --evpi

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

Property	Value
Parameter group:	Default Event Arguments

--event-queue-size --evqs

Queue size for events. Minimum: 0.

Property	Value
Parameter group:	Default Event Arguments

--hardware-revision --hw-rev

Hardware revision information.

Property	Value
Parameter group:	Additional Info Arguments

--manufacturer

Manufacturer name.

Property	Value
Parameter group:	Additional Info Arguments

--manufacturer-uri --mfr-uri

Manufacturer URI.

Property	Value
Parameter group:	Additional Info Arguments

--model

Model name or number.

Property	Value
Parameter group:	Additional Info Arguments

--pc --product-code

Product code.

Property	Value
Parameter group:	Additional Info Arguments

--serial-number --sn

Serial number.

Property	Value
Parameter group:	Additional Info Arguments

--software-revision --sw-rev

Software revision information.

Property	Value
Parameter group:	Additional Info Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 update

Preview

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

Update an OPC UA namespaced asset in an IoT Operations instance.

The device endpoint must be of type Microsoft.OpcUa.

az iot ops ns asset opcua update --instance
                                 --name
                                 --resource-group
                                 [--asset-type-ref --type-ref]
                                 [--attr --attribute]
                                 [--dataset-dest --dsd]
                                 [--dataset-key-frame-count --dskfc]
                                 [--dataset-publish-int --dspi]
                                 [--dataset-queue-size --dsqs]
                                 [--dataset-sampling-int --dssi]
                                 [--description]
                                 [--disable {false, true}]
                                 [--display-name --dn]
                                 [--doc-uri --documentation-uri]
                                 [--eid --external-asset-id]
                                 [--evd --event-dest]
                                 [--event-publish-int --evpi]
                                 [--event-queue-size --evqs]
                                 [--hardware-revision --hw-rev]
                                 [--manufacturer]
                                 [--manufacturer-uri --mfr-uri]
                                 [--model]
                                 [--pc --product-code]
                                 [--serial-number --sn]
                                 [--software-revision --sw-rev]
                                 [--tags]

Examples

Update an OPC UA asset's basic properties

az iot ops ns asset opcua update --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --description "Updated factory PLC" --display-name "Production Line Controller"

Update an OPC UA asset's dataset configuration

az iot ops ns asset opcua update --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --dataset-publish-int 500 --dataset-sampling-int 250 --dataset-queue-size 10 --dataset-key-frame-count 2

Update an OPC UA asset's event configuration

az iot ops ns asset opcua update --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --event-publish-int 1000 --event-queue-size 5

Update an OPC UA asset's destination configurations

az iot ops ns asset opcua update --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --dataset-dest topic="factory/opcua/data/updated" retain=Keep qos=Qos1 ttl=7200 --event-dest topic="factory/opcua/events/updated" retain=Never qos=Qos1 ttl=3600

Update an OPC UA asset's metadata and attributes

az iot ops ns asset opcua update --name myopcuaasset --instance myInstance -g myInstanceResourceGroup --manufacturer "Automation Corp" --model "PLC-2000" --serial-number "PLC87654" --attribute location=factory-floor zone="production line"

Required Parameters

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Name of the asset.

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

--asset-type-ref --type-ref

Space-separated list of asset type references.

Property	Value
Parameter group:	Additional Info Arguments

--attr --attribute

Space-separated key=value pairs for custom asset attributes.

Property	Value
Parameter group:	Additional Info Arguments

--dataset-dest --dsd

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-key-frame-count --dskfc

Key frame count for datasets. Minimum: 0.

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-publish-int --dspi

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

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-queue-size --dsqs

Queue size for datasets. Minimum: 0.

Property	Value
Parameter group:	Default Dataset Arguments

--dataset-sampling-int --dssi

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

Property	Value
Parameter group:	Default Dataset Arguments

--description

Description of the asset.

Property	Value
Parameter group:	Additional Info Arguments

--disable

Disable the asset.

Property	Value
Parameter group:	Additional Info Arguments
Accepted values:	false, true

--display-name --dn

Display name for the asset.

Property	Value
Parameter group:	Additional Info Arguments

--doc-uri --documentation-uri

Documentation URI for the asset.

Property	Value
Parameter group:	Additional Info Arguments

--eid --external-asset-id

External asset ID.

Property	Value
Parameter group:	Additional Info Arguments

--evd --event-dest

Property	Value
Parameter group:	Default Event Arguments

--event-publish-int --evpi

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

Property	Value
Parameter group:	Default Event Arguments

--event-queue-size --evqs

Queue size for events. Minimum: 0.

Property	Value
Parameter group:	Default Event Arguments

--hardware-revision --hw-rev

Hardware revision information.

Property	Value
Parameter group:	Additional Info Arguments

--manufacturer

Manufacturer name.

Property	Value
Parameter group:	Additional Info Arguments

--manufacturer-uri --mfr-uri

Manufacturer URI.

Property	Value
Parameter group:	Additional Info Arguments

--model

Model name or number.

Property	Value
Parameter group:	Additional Info Arguments

--pc --product-code

Product code.

Property	Value
Parameter group:	Additional Info Arguments

--serial-number --sn

Serial number.

Property	Value
Parameter group:	Additional Info Arguments

--software-revision --sw-rev

Software revision information.

Property	Value
Parameter group:	Additional Info Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Feedback

Was this page helpful?

Share via

az iot ops ns asset opcua

Commands

az iot ops ns asset opcua create

Examples

Required Parameters

Optional Parameters

az iot ops ns asset opcua update

Examples

Required Parameters

Optional Parameters

Feedback