az iot ops connector

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 connector command. Learn more about extensions.

Connector management.

Commands

Name	Description	Type	Status
az iot ops connector list	List first-party and purchased Marketplace connectors for a preview instance.	Extension	Preview
az iot ops connector opcua	OPC UA connector management.	Extension	GA
az iot ops connector opcua client	Manage enterprise grade client application instance certificate for the OPC UA Broker.	Extension	GA
az iot ops connector opcua client add	Add an enterprise grade client application instance certificate.	Extension	GA
az iot ops connector opcua client remove	Remove client application instance certificate from the OPC UA Broker.	Extension	GA
az iot ops connector opcua client show	Show details of secretsync resource 'aio-opc-ua-broker-client-certificate'.	Extension	GA
az iot ops connector opcua issuer	Manage issuer certificates for the OPC UA Broker.	Extension	GA
az iot ops connector opcua issuer add	Add an issuer certificate to the OPC UA Broker's issuer certificate list.	Extension	GA
az iot ops connector opcua issuer remove	Remove trusted certificate(s) from the OPC UA Broker's issuer certificate list.	Extension	GA
az iot ops connector opcua issuer show	Show details of secretsync resource 'aio-opc-ua-broker-issuer-list'.	Extension	GA
az iot ops connector opcua trust	Manage trusted certificates for the OPC UA Broker.	Extension	GA
az iot ops connector opcua trust add	Add a trusted certificate to the OPC UA Broker's trusted certificate list.	Extension	GA
az iot ops connector opcua trust remove	Remove trusted certificate(s) from the OPC UA Broker's trusted certificate list.	Extension	GA
az iot ops connector opcua trust show	Show details of secretsync resource 'aio-opc-ua-broker-trust-list'.	Extension	GA
az iot ops connector show	Inspect a connector metadata artifact from its fully qualified reference.	Extension	Preview
az iot ops connector template	Connector template management.	Extension	GA
az iot ops connector template create	Create a new connector template.	Extension	GA
az iot ops connector template delete	Delete a connector template.	Extension	GA
az iot ops connector template list	List all connector templates.	Extension	GA
az iot ops connector template show	Display a connector template.	Extension	GA
az iot ops connector template update	Update an existing connector template.	Extension	GA

az iot ops connector list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List first-party and purchased Marketplace connectors for a preview instance.

Requires a supported preview runtime and read access to application definitions. Returns names, discovery sources and fully qualified metadata references. First-party versions are discovered from the registry. Metadata is checked newest-first to select the latest version compatible with the installed CLI's bundled preview runtime. Connectors with no compatible version are omitted. The instance is checked for preview eligibility and readiness, not for a matching runtime version. Verify compatibility with an older installed runtime before deploying a listed connector. Versioned prerelease tags participate in semantic version ordering. Compatibility requires aioMinVersion. Missing required metadata fields or invalid compatibility information is an error. Registry errors are not hidden. Purchased Marketplace connector references are returned unchanged without downloading their metadata. Other application definitions are not included. No purchased connectors is a successful result containing compatible first-party entries. Purchase additional connectors in Azure Marketplace: https://marketplace.microsoft.com/en-us/search/products?search=iot%20operations Purchase and terms acceptance remain in Marketplace. After purchase or installation, rerun this command; immediate visibility is not guaranteed. The link does not carry the selected instance or cluster context.

az iot ops connector list --instance
                          --resource-group

Examples

List available connectors for a preview instance.

az iot ops connector list -i myinstance -g myresourcegroup -o table

Return purchased connector metadata references.

az iot ops connector list -i myinstance -g myresourcegroup --query "[?source=='Marketplace'].metadataRef" -o tsv

Required Parameters

--instance -i

IoT Operations instance name.

--resource-group -g

Instance resource group.

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 connector show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Inspect a connector metadata artifact from its fully qualified reference.

Requires a preview instance and its resource group. Validates the instance's preview eligibility and readiness before returning the supplied reference and complete parsed metadata. Running connector list first is not required. This does not check whether the connector is purchased, compatible with the instance or deployed and healthy. Use JSON or YAML output for nested metadata; table output shows name, version and metadata reference.

az iot ops connector show --connector-metadata-ref --ref
                          --instance
                          --resource-group

Examples

Inspect a first-party connector metadata artifact.

az iot ops connector show -i myinstance -g myresourcegroup --ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.3.2

Show endpoint details from a purchased connector metadata reference.

az iot ops connector show -i myinstance -g myresourcegroup --ref $METADATA_REF --query metadata.inboundEndpoints

Required Parameters

--connector-metadata-ref --ref

Fully qualified connector metadata artifact reference from a container registry.

--instance -i

IoT Operations instance name.

--resource-group -g

Instance resource group.

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?