az iot ops ns asset opcua event-group

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 opcua event-group command. Learn more about extensions.

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

Commands

Name	Description	Type	Status
az iot ops ns asset opcua event-group add	Add an event group to an OPC UA namespaced asset in an IoT Operations instance.	Extension	GA
az iot ops ns asset opcua event-group export	Export event-groups to file.	Extension	GA
az iot ops ns asset opcua event-group import	Import event-groups from file.	Extension	GA
az iot ops ns asset opcua event-group list	List event groups for an OPC UA namespaced asset in an IoT Operations instance.	Extension	GA
az iot ops ns asset opcua event-group remove	Remove an event group from an OPC UA namespaced asset in an IoT Operations instance.	Extension	GA
az iot ops ns asset opcua event-group show	Show details of an event group for an OPC UA namespaced asset in an IoT Operations instance.	Extension	GA
az iot ops ns asset opcua event-group update	Update an event group for an OPC UA namespaced asset in an IoT Operations instance.	Extension	GA

az iot ops ns asset opcua event-group add

Add an event group to an OPC UA namespaced asset in an IoT Operations instance.

az iot ops ns asset opcua event-group add --asset
                                          --instance
                                          --name
                                          --resource-group
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--data-source --ds]
                                          [--dest --destination]
                                          [--fc --filter-clause]
                                          [--filter-type --ft]
                                          [--pi --publish-int]
                                          [--qs --queue-size]
                                          [--replace {false, true}]
                                          [--start --start-inst]

Examples

Add a basic OPC UA event group

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --data-source "ns=2;i=1000"

Add an OPC UA event group with publishing interval and queue size

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name systemEvent --data-source "ns=2;i=200" --publish-int 1500 --queue-size 8

Add an OPC UA event group with MQTT destination

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name criticalAlarm --data-source "ns=2;i=4000" --dest topic="factory/opcua/alarms" retain=Keep qos=Qos0 ttl=7200

Replace an OPC UA event group with same name

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --data-source "ns=3;i=1000" --replace

Add an OPC UA event group with a start instance

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --data-source "ns=2;i=1000" --start-inst "ns=3;i=3001"

Add an OPC UA event group with filter type and filter clauses

az iot ops ns asset opcua event-group add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --data-source "ns=2;i=1000" --filter-type "ns=2;i=5001" --filter-clause path="/EventType" type="ns=2;i=5001"

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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 event group.

--dest --destination

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 Keep and Never and allowed values for qos are Qos0 and Qos1.

--fc --filter-clause

Space-separated key=value pairs for event filter clauses. Allowed keys are path (required), type, and field. This parameter can be specified multiple times to add multiple clauses.

--filter-type --ft

Filter type definition ID for the event group configuration.

--pi --publish-int

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

--qs --queue-size

Queue size for events. Minimum: 0.

--replace

Replace the event group if another event group with the same name is already present.

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

--start --start-inst

Start instance for events.

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 event-group export

Export event-groups to file.

Export all event-groups from an asset to JSON or YAML format.

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

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.

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

--od --output-dir

Output directory for export.

Property	Value
Default value:	.

--replace

Replace the event group if another event group with the same name is already 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 opcua event-group import

Import event-groups from file.

Import event-groups from JSON or YAML file. Use --replace to merge with overwrite.

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

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 the event group if another event group with the same name is already 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 opcua event-group list

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

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

Examples

List all event groups for an OPC UA asset

az iot ops ns asset opcua event-group 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 event-group remove

Remove an event group from an OPC UA namespaced asset in an IoT Operations instance.

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

Examples

Remove an event group from an OPC UA asset

az iot ops ns asset opcua event-group remove --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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 opcua event-group show

Show details of an event group for an OPC UA namespaced asset in an IoT Operations instance.

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

Examples

Show event group details

az iot ops ns asset opcua event-group show --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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 event-group update

Update an event group for an OPC UA namespaced asset in an IoT Operations instance.

az iot ops ns asset opcua event-group update --asset
                                             --instance
                                             --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--data-source --ds]
                                             [--dest --destination]
                                             [--fc --filter-clause]
                                             [--filter-type --ft]
                                             [--pi --publish-int]
                                             [--qs --queue-size]
                                             [--start --start-inst]

Examples

Update event group publishing interval and queue size

az iot ops ns asset opcua event-group update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --publish-int 2000 --queue-size 10

Update event group destination

az iot ops ns asset opcua event-group update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name systemEvent --dest topic="factory/opcua/system/updated" retain=Never qos=Qos1 ttl=3600

Update event group start instance and filter configuration

az iot ops ns asset opcua event-group update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name alarmEvent --start-inst "ns=3;i=4001" --filter-type "ns=2;i=5002" --filter-clause path="/Severity" type="ns=2;i=5002"

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name

Event group 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 event group.

--dest --destination

--fc --filter-clause

Space-separated key=value pairs for event filter clauses. Allowed keys are path (required), type, and field. This parameter can be specified multiple times to add multiple clauses.

--filter-type --ft

Filter type definition ID for the event group configuration.

--pi --publish-int

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

--qs --queue-size

Queue size for events. Minimum: 0.

--start --start-inst

Start instance for events.

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 event-group

Commands

az iot ops ns asset opcua event-group add

Examples

Required Parameters

Optional Parameters

az iot ops ns asset opcua event-group export

Required Parameters

Optional Parameters

az iot ops ns asset opcua event-group import

Required Parameters

Optional Parameters

az iot ops ns asset opcua event-group list

Examples

Required Parameters

az iot ops ns asset opcua event-group remove

Examples

Required Parameters

Optional Parameters

az iot ops ns asset opcua event-group show

Examples

Required Parameters

az iot ops ns asset opcua event-group update

Examples

Required Parameters

Optional Parameters

Feedback