az iot ops

Commands

Name	Description	Type	Status
az iot ops asset	Asset management.	Extension	Preview
az iot ops asset create	Create an asset.	Extension	Preview
az iot ops asset dataset	Manage datasets in an asset.	Extension	Preview
az iot ops asset dataset list	List datasets within an asset.	Extension	Preview
az iot ops asset dataset point	Manage data-points in an asset dataset.	Extension	Preview
az iot ops asset dataset point add	Add a data point to an asset dataset.	Extension	Preview
az iot ops asset dataset point export	Export data-points in an asset dataset.	Extension	Preview
az iot ops asset dataset point import	Import data-points in an asset dataset.	Extension	Preview
az iot ops asset dataset point list	List data-points in an asset dataset.	Extension	Preview
az iot ops asset dataset point remove	Remove a data point in an asset dataset.	Extension	Preview
az iot ops asset dataset show	Show a dataset within an asset.	Extension	Preview
az iot ops asset delete	Delete an asset.	Extension	Preview
az iot ops asset endpoint	Manage asset endpoint profiles.	Extension	Preview
az iot ops asset endpoint create	Create asset endpoint profiles.	Extension	Preview
az iot ops asset endpoint create opcua	Create an asset endpoint profile with an OPCUA connector.	Extension	Preview
az iot ops asset endpoint delete	Delete an asset endpoint profile.	Extension	Preview
az iot ops asset endpoint query	Query the Resource Graph for asset endpoint profiles.	Extension	Preview
az iot ops asset endpoint show	Show an asset endpoint profile.	Extension	Preview
az iot ops asset endpoint update	Update an asset endpoint profile.	Extension	Preview
az iot ops asset event	Manage events in an asset.	Extension	Preview
az iot ops asset event add	Add an event to an asset.	Extension	Preview
az iot ops asset event export	Export events in an asset.	Extension	Preview
az iot ops asset event import	Import events in an asset.	Extension	Preview
az iot ops asset event list	List events in an asset.	Extension	Preview
az iot ops asset event remove	Remove an event in an asset.	Extension	Preview
az iot ops asset query	Query the Resource Graph for assets.	Extension	Preview
az iot ops asset show	Show an asset.	Extension	Preview
az iot ops asset update	Update an asset.	Extension	Preview
az iot ops broker	Mqtt broker management.	Extension	Preview
az iot ops broker authn	Broker authentication management.	Extension	Preview
az iot ops broker authn delete	Delete an mqtt broker authentication resource.	Extension	Preview
az iot ops broker authn list	List mqtt broker authentication resources associated with an instance.	Extension	Preview
az iot ops broker authn show	Show details of an mqtt broker authentication resource.	Extension	Preview
az iot ops broker authz	Broker authorization management.	Extension	Preview
az iot ops broker authz delete	Delete an mqtt broker authorization resource.	Extension	Preview
az iot ops broker authz list	List mqtt broker authorization resources associated with an instance.	Extension	Preview
az iot ops broker authz show	Show details of an mqtt broker authorization resource.	Extension	Preview
az iot ops broker delete	Delete an mqtt broker.	Extension	Preview
az iot ops broker list	List mqtt brokers associated with an instance.	Extension	Preview
az iot ops broker listener	Broker listener management.	Extension	Preview
az iot ops broker listener delete	Delete an mqtt broker listener.	Extension	Preview
az iot ops broker listener list	List mqtt broker listeners associated with a broker.	Extension	Preview
az iot ops broker listener show	Show details of an mqtt broker listener.	Extension	Preview
az iot ops broker show	Show details of an mqtt broker.	Extension	Preview
az iot ops broker stats	Show dmqtt running statistics.	Extension	Preview
az iot ops check	Evaluate cluster-side readiness and runtime health of deployed IoT Operations services.	Extension	Preview
az iot ops connector	Connector management.	Extension	Preview
az iot ops connector opcua	OPC UA connector management.	Extension	Preview
az iot ops connector opcua client	Manage enterprise grade client application instance certificate for the OPC UA Broker.	Extension	Preview
az iot ops connector opcua client add	Add an enterprise grade client application instance certificate.	Extension	Preview
az iot ops connector opcua issuer	Manage issuer certificates for the OPC UA Broker.	Extension	Preview
az iot ops connector opcua issuer add	Add an issuer certificate to the OPC UA Broker's issuer certificate list.	Extension	Preview
az iot ops connector opcua trust	Manage trusted certificates for the OPC UA Broker.	Extension	Preview
az iot ops connector opcua trust add	Add a trusted certificate to the OPC UA Broker's trusted certificate list.	Extension	Preview
az iot ops create	Create an IoT Operations instance.	Extension	Preview
az iot ops dataflow	Dataflow management.	Extension	Preview
az iot ops dataflow endpoint	Dataflow endpoint management.	Extension	Preview
az iot ops dataflow endpoint list	List dataflow endpoint resources associated with an instance.	Extension	Preview
az iot ops dataflow endpoint show	Show details of a dataflow endpoint resource.	Extension	Preview
az iot ops dataflow list	List dataflows associated with a dataflow profile.	Extension	Preview
az iot ops dataflow profile	Dataflow profile management.	Extension	Preview
az iot ops dataflow profile list	List dataflow profiles associated with an instance.	Extension	Preview
az iot ops dataflow profile show	Show details of a dataflow profile.	Extension	Preview
az iot ops dataflow show	Show details of a dataflow associated with a dataflow profile.	Extension	Preview
az iot ops delete	Delete IoT Operations from the cluster.	Extension	Preview
az iot ops identity	Instance identity management.	Extension	Preview
az iot ops identity assign	Assign a user-assigned managed identity with the instance.	Extension	Preview
az iot ops identity remove	Remove a user-assigned managed identity from the instance.	Extension	Preview
az iot ops identity show	Show the instance identities.	Extension	Preview
az iot ops init	Bootstrap the Arc-enabled cluster for IoT Operations deployment.	Extension	Preview
az iot ops list	List IoT Operations instances.	Extension	Preview
az iot ops schema	Schema and registry management.	Extension	Preview
az iot ops schema create	Create a schema within a schema registry.	Extension	Preview
az iot ops schema delete	Delete a target schema within a schema registry.	Extension	Preview
az iot ops schema list	List schemas within a schema registry.	Extension	Preview
az iot ops schema registry	Schema registry management.	Extension	Preview
az iot ops schema registry create	Create a schema registry.	Extension	Preview
az iot ops schema registry delete	Delete a target schema registry.	Extension	Preview
az iot ops schema registry list	List schema registries in a resource group or subscription.	Extension	Preview
az iot ops schema registry show	Show details of a schema registry.	Extension	Preview
az iot ops schema show	Show details of a schema within a schema registry.	Extension	Preview
az iot ops schema show-dataflow-refs	Show the schema references used for dataflows.	Extension	Preview
az iot ops schema version	Schema version management.	Extension	Preview
az iot ops schema version add	Add a schema version to a schema.	Extension	Preview
az iot ops schema version list	List schema versions for a specific schema.	Extension	Preview
az iot ops schema version remove	Remove a target schema version.	Extension	Preview
az iot ops schema version show	Show details of a schema version.	Extension	Preview
az iot ops secretsync	Instance secret sync management.	Extension	Preview
az iot ops secretsync disable	Disable secret sync for an instance.	Extension	Preview
az iot ops secretsync enable	Enable secret sync for an instance.	Extension	Preview
az iot ops secretsync list	List the secret sync configs associated with an instance.	Extension	Preview
az iot ops show	Show an IoT Operations instance.	Extension	Preview
az iot ops support	IoT Operations support operations.	Extension	Preview
az iot ops support create-bundle	Creates a standard support bundle zip archive for use in troubleshooting and diagnostics.	Extension	Preview
az iot ops update	Update an IoT Operations instance.	Extension	Preview
az iot ops upgrade	Upgrade an IoT Operations instance to the latest version.	Extension	Preview
az iot ops verify-host	Runs a set of cluster host verifications for IoT Operations deployment compatibility.	Extension	Preview

az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, broker, dataflow, deviceregistry, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, dataflow, dataflowendpoint, dataflowprofile}]

Examples

Basic usage. Checks overall IoT Operations health with summary output.

az iot ops check

Checks `broker` service health and configuration with detailed output.

az iot ops check --svc broker --detail-level 1

Evaluate only the `dataflow` service with output optimized for CI.

az iot ops check --svc dataflow --as-object

Checks `deviceregistry` health with verbose output, but constrains results to `asset` resources.

az iot ops check --svc deviceregistry --detail-level 2 --resources asset

Use resource name to constrain results to `asset` resources with `my-asset-` name prefix

az iot ops check --svc deviceregistry --resources asset --resource-name 'my-asset-*'

Optional Parameters

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.

az iot ops create --cluster
                  --name
                  --resource-group
                  --sr-resource-id
                  [--add-insecure-listener {false, true}]
                  [--bp]
                  [--br]
                  [--broker-backend-workers]
                  [--broker-config-file]
                  [--broker-frontend-replicas]
                  [--broker-frontend-workers]
                  [--broker-listener-type {ClusterIp, LoadBalancer, NodePort}]
                  [--broker-mem-profile {High, Low, Medium, Tiny}]
                  [--cluster-namespace]
                  [--custom-location]
                  [--description]
                  [--df-profile-instances]
                  [--enable-rsync {false, true}]
                  [--kubernetes-distro {K3s, K8s, MicroK8s}]
                  [--location]
                  [--no-progress {false, true}]
                  [--ops-config]
                  [--ops-version]
                  [--runtime-socket]
                  [--tags]
                  [--trust-settings]

Examples

Create the target instance with minimum input.

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID

The following example adds customization to the default broker instance resource as well as an instance description and tags.

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --broker-mem-profile High --broker-backend-workers 4 --description 'Contoso Factory' --tags tier=testX1

This example shows deploying an additional insecure (no authn or authz) broker listener configured for port 1883 of service type load balancer. Useful for testing and/or demos. Do not use the insecure option in production.

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --add-insecure-listener

This form shows how to enable resource sync for the instance deployment. To enable resource sync role assignment write is necessary on the target resource group.

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --enable-rsync

This example highlights trust settings for a user provided cert-manager config. Note that the cluster must have been initialized with `--user-trust` and a user cert-manager deployment must be present.

az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --trust-settings configMapName=example-bundle configMapKey=trust-bundle.pem issuerKind=ClusterIssuer issuerName=trust-manager-selfsigned-issuer

Required Parameters

Optional Parameters

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.

az iot ops delete --resource-group
                  [--cluster]
                  [--force {false, true}]
                  [--include-deps {false, true}]
                  [--name]
                  [--no-progress {false, true}]
                  [--yes {false, true}]

Examples

Minimum input for complete deletion.

az iot ops delete -n myinstance -g myresourcegroup

Skip confirmation prompt and continue to deletion process. Useful for CI scenarios.

az iot ops delete -n myinstance -g myresourcegroup -y

Force deletion regardless of warnings. May lead to errors.

az iot ops delete -n myinstance -g myresourcegroup --force

Use cluster name instead of instance for lookup.

az iot ops delete --cluster mycluster -g myresourcegroup

Reverse application of init.

az iot ops delete -n myinstance -g myresourcegroup --include-deps

Required Parameters

Optional Parameters

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.

az iot ops init --cluster
                --resource-group
                [--enable-fault-tolerance {false, true}]
                [--ensure-latest {false, true}]
                [--no-progress {false, true}]
                [--user-trust {false, true}]

Examples

Usage with minimum input. This form will deploy the IoT Operations foundation layer.

az iot ops init --cluster mycluster -g myresourcegroup

Similar to the prior example but with Arc Container Storage fault-tolerance enabled (requires at least 3 nodes).

az iot ops init --cluster mycluster -g myresourcegroup --enable-fault-tolerance

This example highlights enabling user trust settings for a custom cert-manager config. This will skip deployment of the system cert-manager and trust-manager.

az iot ops init --cluster mycluster -g myresourcegroup --user-trust

Required Parameters

Optional Parameters

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.

az iot ops list [--resource-group]

Examples

List all instances in the subscription.

az iot ops list

List all instances of a particular resource group.

az iot ops list -g myresourcegroup

List the instances in the subscription that have a particular tag value.

az iot ops list -g myresourcegroup --query "[?tags.env == 'prod']"

Optional Parameters

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.

az iot ops show --name
                --resource-group
                [--tree {false, true}]

Examples

Basic usage to show an instance.

az iot ops show --name myinstance -g myresourcegroup

Output a tree structure of associated resources representing the IoT Operations deployment.

az iot ops show --name myinstance -g myresourcegroup --tree

Required Parameters

Optional Parameters

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.

az iot ops update --name
                  --resource-group
                  [--description]
                  [--tags]

Examples

Update instance tags. This is equivalent to a replace.

az iot ops update --name myinstance -g myresourcegroup --tags a=b c=d

Remove instance tags.

az iot ops update --name myinstance -g myresourcegroup --tags ""

Update the instance description.

az iot ops update --name myinstance -g myresourcegroup --desc "Fabrikam Widget Factory B42"

Required Parameters

Optional Parameters

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.

az iot ops upgrade --name
                   --resource-group
                   [--no-progress {false, true}]
                   [--sr-resource-id]
                   [--yes {false, true}]

Examples

Upgrade the instance with minimal inputs.

az iot ops upgrade --name myinstance -g myresourcegroup

Skip the conformation prompt during instance upgrade.

az iot ops upgrade --name myinstance -g myresourcegroup -y

Upgrade the instance and specify the schema registry resource Id.

az iot ops upgrade --name myinstance -g myresourcegroup --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID

Required Parameters

Optional Parameters

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.

az iot ops verify-host [--no-progress {false, true}]

Optional Parameters

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.