Share via

az iot ops ns asset opcua mgmt

  • 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 mgmt 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 OPC UA asset management groups in an IoT Operations instance.

Management groups define collections of management actions that can be performed on OPC UA assets. Each management group contains actions with specific configurations and targets.

Commands

Name Description Type Status
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 mgmt add

Preview

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

Add a management group to an OPC UA asset.

az iot ops ns asset opcua mgmt add --asset
                                   --instance
                                   --name
                                   --resource-group
                                   [--default-timeout --dto]
                                   [--default-topic --dt]
                                   [--replace {false, true}]

Examples

Add a basic management group to an OPC UA asset.

az iot ops ns asset opcua mgmt add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup

Add a management group with default topic and timeout.

az iot ops ns asset opcua mgmt add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup --default-topic factory/opcua/management/responses --default-timeout 30

Replace an existing management group with the same name.

az iot ops ns asset opcua mgmt add --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup --default-topic factory/opcua/control/commands --default-timeout 60 --replace

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

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

--default-timeout --dto

Default timeout in seconds for management group actions. Minimum: 0.

--default-topic --dt

Default topic for management group actions.

--replace

Replace the management if another management 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 mgmt list

Preview

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

List management groups for an OPC UA asset.

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

Examples

List all management groups for an OPC UA asset.

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

Preview

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

Remove a management group from an OPC UA asset.

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

Examples

Remove a management group from an OPC UA asset.

az iot ops ns asset opcua mgmt remove --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Management 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 mgmt 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 management group for an OPC UA asset.

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

Examples

Show details of a specific management group.

az iot ops ns asset opcua mgmt show --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

Management 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 mgmt update

Preview

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

Update a management group for an OPC UA asset.

az iot ops ns asset opcua mgmt update --asset
                                      --instance
                                      --name
                                      --resource-group
                                      [--default-timeout --dto]
                                      [--default-topic --dt]

Examples

Update the default topic and timeout for a management group.

az iot ops ns asset opcua mgmt update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup --default-topic factory/opcua/updated/responses --default-timeout 45

Update only the default timeout for a management group.

az iot ops ns asset opcua mgmt update --asset myopcuaasset --instance myInstance -g myInstanceResourceGroup --name myManagementGroup --default-timeout 90

Required Parameters

--asset -a

Asset name.

--instance -i

The name of the Azure IoT Operations instance.

--name -n

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

--default-timeout --dto

Default timeout in seconds for management group actions. Minimum: 0.

--default-topic --dt

Default topic for management group actions.

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