az iot ops connector opcua client

Preview
Reference

Note

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

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

Manage enterprise grade client application instance certificate for the OPC UA Broker.

The connector for OPC UA makes use of a single OPC UA application instance certificate for all the sessions it establishes to collect telemetry data from OPC UA servers. For more info, see https://aka.ms/opcua-certificates.

Commands

Name	Description	Type	Status
az iot ops connector opcua client add	Add an enterprise grade client application instance certificate.	Extension	Preview

az iot ops connector opcua client add

Preview

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

Add an enterprise grade client application instance certificate.

The public key file extension must be .der and private key file extension must be .pem. Please make sure to use same filename for public key and private key file. Azure resource secretproviderclass 'opc-ua-connector' and secretsync 'aio-opc-ua-broker-client-certificate' will be created if not found.

az iot ops connector opcua client add --application-uri
                                      --instance
                                      --pkf
                                      --private-key-file
                                      --resource-group
                                      --sn
                                      [--pks]
                                      [--private-key-secret]

Examples

Add an client certificate.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem" --subject-name "aio-opc-opcuabroker" --application-uri "urn:microsoft.com:aio:opc:opcuabroker"

Add an client certificate with custom public and private key secret name.

az iot ops connector opcua client add --instance instance --resource-group instanceresourcegroup --public-key-file "newopc.der" --private-key-file "newopc.pem" --public-key-secret public-secret-name --private-key-secret private-secret-name --subject-name "aio-opc-opcuabroker" --application-uri "urn:microsoft.com:aio:opc:opcuabroker"

Required Parameters

--application-uri --au

The application instance URI embedded in the application instance.

--instance -i

IoT Operations instance name.

--pkf --public-key-file

File that contains the enterprise grade application instance certificate public key in .der format. File name will be used to generate the public key secret name.

--private-key-file --prkf

File that contains the enterprise grade application instance certificate private key in .pem format. File name will be used to generate the private key secret name.

--resource-group -g

Instance resource group.

--sn --subject-name

The subject name string embedded in the application instance certificate.

Optional Parameters

--pks --public-key-secret

Public key secret name in the Key Vault. If not provided, the certificate file name will be used to generate the secret name.

--private-key-secret --prks

Private key secret name in the Key Vault. If not provided, the certificate file name will be used to generate the secret name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via