az iot ops
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 command. Learn more about extensions.
Manage Azure IoT Operations.
Azure IoT Operations is a set of highly aligned, but loosely coupled, first-party Kubernetes services that enable you to aggregate data from on-prem assets into an industrial-grade MQTT Broker, add edge compute and set up bi-directional data flow with a variety of services in the cloud.
By default IoT Operations CLI commands will periodically check to see if a new extension version is available.
This behavior can be disabled with az config set iotops.check_latest=false.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot ops asset |
Asset management. |
Extension | GA |
| az iot ops asset create |
Create an asset. |
Extension | GA |
| az iot ops asset dataset |
Manage datasets in an asset. |
Extension | GA |
| az iot ops asset dataset list |
List datasets within an asset. |
Extension | GA |
| az iot ops asset dataset point |
Manage data-points in an asset dataset. |
Extension | GA |
| az iot ops asset dataset point add |
Add a data point to an asset dataset. |
Extension | GA |
| az iot ops asset dataset point export |
Export data-points in an asset dataset. |
Extension | GA |
| az iot ops asset dataset point import |
Import data-points in an asset dataset. |
Extension | GA |
| az iot ops asset dataset point list |
List data-points in an asset dataset. |
Extension | GA |
| az iot ops asset dataset point remove |
Remove a data point in an asset dataset. |
Extension | GA |
| az iot ops asset dataset show |
Show a dataset within an asset. |
Extension | GA |
| az iot ops asset delete |
Delete an asset. |
Extension | GA |
| az iot ops asset endpoint |
Manage asset endpoint profiles. |
Extension | GA |
| az iot ops asset endpoint create |
Create asset endpoint profiles. |
Extension | GA |
| az iot ops asset endpoint create opcua |
Create an asset endpoint profile for an OPCUA connector. |
Extension | GA |
| az iot ops asset endpoint delete |
Delete an asset endpoint profile. |
Extension | GA |
| az iot ops asset endpoint query |
Query the Resource Graph for asset endpoint profiles. |
Extension | GA |
| az iot ops asset endpoint show |
Show an asset endpoint profile. |
Extension | GA |
| az iot ops asset endpoint update |
Update an asset endpoint profile. |
Extension | GA |
| az iot ops asset event |
Manage events in an asset. |
Extension | GA |
| az iot ops asset event add |
Add an event to an asset. |
Extension | GA |
| az iot ops asset event export |
Export events in an asset. |
Extension | GA |
| az iot ops asset event import |
Import events in an asset. |
Extension | GA |
| az iot ops asset event list |
List events in an asset. |
Extension | GA |
| az iot ops asset event remove |
Remove an event in an asset. |
Extension | GA |
| az iot ops asset query |
Query the Resource Graph for assets. |
Extension | GA |
| az iot ops asset show |
Show an asset. |
Extension | GA |
| az iot ops asset update |
Update an asset. |
Extension | GA |
| az iot ops broker |
Mqtt broker management. |
Extension | GA |
| az iot ops broker authn |
Mqtt broker authentication management. |
Extension | GA |
| az iot ops broker authn apply |
Create or replace an mqtt broker authentication resource. |
Extension | GA |
| az iot ops broker authn delete |
Delete an mqtt broker authentication resource. |
Extension | GA |
| az iot ops broker authn list |
List mqtt broker authentication resources associated with a broker. |
Extension | GA |
| az iot ops broker authn method |
Mqtt broker authn method operations. |
Extension | GA |
| az iot ops broker authn method add |
Add authentication methods to an mqtt broker authentication resource. |
Extension | GA |
| az iot ops broker authn show |
Show details of an mqtt broker authentication resource. |
Extension | GA |
| az iot ops broker authz |
Mqtt broker authorization management. |
Extension | GA |
| az iot ops broker authz apply |
Create or replace an mqtt broker authorization resource. |
Extension | GA |
| az iot ops broker authz delete |
Delete an mqtt broker authorization resource. |
Extension | GA |
| az iot ops broker authz list |
List mqtt broker authorization resources associated with a broker. |
Extension | GA |
| az iot ops broker authz show |
Show details of an mqtt broker authorization resource. |
Extension | GA |
| az iot ops broker list |
List mqtt brokers associated with an instance. |
Extension | GA |
| az iot ops broker listener |
Mqtt broker listener management. |
Extension | GA |
| az iot ops broker listener apply |
Create or replace an mqtt broker listener service. |
Extension | GA |
| az iot ops broker listener delete |
Delete an mqtt broker listener. |
Extension | GA |
| az iot ops broker listener list |
List mqtt broker listeners associated with a broker. |
Extension | GA |
| az iot ops broker listener port |
Mqtt broker listener port operations. |
Extension | GA |
| az iot ops broker listener port add |
Add a tcp port config to an mqtt broker listener service. |
Extension | GA |
| az iot ops broker listener port remove |
Remove a tcp port config from an mqtt broker listener service. |
Extension | GA |
| az iot ops broker listener show |
Show details of an mqtt broker listener. |
Extension | GA |
| az iot ops broker persist |
Mqtt broker disk persistence management. |
Extension | GA |
| az iot ops broker persist update |
Update an mqtt broker's disk persistence settings. |
Extension | Preview |
| az iot ops broker show |
Show details of an mqtt broker. |
Extension | GA |
| az iot ops check |
Evaluate cluster-side readiness and runtime health of deployed IoT Operations services. |
Extension | Preview |
| az iot ops clone |
Clone an instance. |
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 client remove |
Remove client application instance certificate from the OPC UA Broker. |
Extension | Preview |
| az iot ops connector opcua client show |
Show details of secretsync resource 'aio-opc-ua-broker-client-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 issuer remove |
Remove trusted certificate(s) from the OPC UA Broker's issuer certificate list. |
Extension | Preview |
| az iot ops connector opcua issuer show |
Show details of secretsync resource 'aio-opc-ua-broker-issuer-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 connector opcua trust remove |
Remove trusted certificate(s) from the OPC UA Broker's trusted certificate list. |
Extension | Preview |
| az iot ops connector opcua trust show |
Show details of secretsync resource 'aio-opc-ua-broker-trust-list'. |
Extension | Preview |
| az iot ops create |
Create an IoT Operations instance. |
Extension | GA |
| az iot ops dataflow |
Dataflow management. |
Extension | GA |
| az iot ops dataflow apply |
Create or replace a dataflow associated with a dataflow profile. |
Extension | GA |
| az iot ops dataflow delete |
Delete a dataflow associated with a dataflow profile. |
Extension | GA |
| az iot ops dataflow endpoint |
Dataflow endpoint management. |
Extension | GA |
| az iot ops dataflow endpoint apply |
Create or replace a dataflow endpoint resource. |
Extension | GA |
| az iot ops dataflow endpoint create |
Create or replace a dataflow endpoint resource. |
Extension | GA |
| az iot ops dataflow endpoint create adls |
Create or replace a dataflow endpoint resource for Azure Data Lake Storage Gen2. |
Extension | GA |
| az iot ops dataflow endpoint create adx |
Create or replace a dataflow endpoint resource for Azure Data Explorer. |
Extension | GA |
| az iot ops dataflow endpoint create custom-kafka |
Create or replace a dataflow endpoint resource for custom kafka broker. |
Extension | GA |
| az iot ops dataflow endpoint create custom-mqtt |
Create or replace a dataflow endpoint resource for custom MQTT broker. |
Extension | GA |
| az iot ops dataflow endpoint create eventgrid |
Create or replace a dataflow endpoint resource for Azure Event Grid. |
Extension | GA |
| az iot ops dataflow endpoint create eventhub |
Create or replace a dataflow endpoint resource for kafka-enabled Azure Event Hubs namespace. |
Extension | GA |
| az iot ops dataflow endpoint create fabric-onelake |
Create or replace a dataflow endpoint resource for Microsoft Fabric OneLake. |
Extension | GA |
| az iot ops dataflow endpoint create fabric-realtime |
Create or replace a Microsoft Fabric Real-Time Intelligence data flow endpoint. |
Extension | GA |
| az iot ops dataflow endpoint create local-mqtt |
Create or replace a Azure IoT Operations Local MQTT dataflow endpoint. |
Extension | GA |
| az iot ops dataflow endpoint create local-storage |
Create or replace a local storage dataflow endpoint. |
Extension | GA |
| az iot ops dataflow endpoint delete |
Delete a dataflow endpoint resource. |
Extension | GA |
| az iot ops dataflow endpoint list |
List dataflow endpoint resources associated with an instance. |
Extension | GA |
| az iot ops dataflow endpoint show |
Show details of a dataflow endpoint resource. |
Extension | GA |
| az iot ops dataflow endpoint update |
Update the properties of an existing dataflow endpoint resource. |
Extension | GA |
| az iot ops dataflow endpoint update adls |
Update the properties of an existing dataflow endpoint resource for Azure Data Lake Storage Gen2. |
Extension | GA |
| az iot ops dataflow endpoint update adx |
Update the properties of an existing dataflow endpoint resource for Azure Data Explorer. |
Extension | GA |
| az iot ops dataflow endpoint update custom-kafka |
Update the properties of an existing dataflow endpoint resource for custom kafka broker. |
Extension | GA |
| az iot ops dataflow endpoint update custom-mqtt |
Update the properties of an existing dataflow endpoint resource for custom MQTT broker. |
Extension | GA |
| az iot ops dataflow endpoint update eventgrid |
Update the properties of an existing dataflow endpoint resource for Azure Event Grid. |
Extension | GA |
| az iot ops dataflow endpoint update eventhub |
Update the properties of an existing dataflow endpoint resource for kafka-enabled Azure Event Hubs namespace. |
Extension | GA |
| az iot ops dataflow endpoint update fabric-onelake |
Update the properties of an existing dataflow endpoint resource for Microsoft Fabric OneLake. |
Extension | GA |
| az iot ops dataflow endpoint update fabric-realtime |
Update the properties of an existing Microsoft Fabric Real-Time Intelligence data flow endpoint. |
Extension | GA |
| az iot ops dataflow endpoint update local-mqtt |
Update the properties of an existing Azure IoT Operations Local MQTT data flow endpoint. |
Extension | GA |
| az iot ops dataflow endpoint update local-storage |
Update the properties of an existing local storage data flow endpoint. |
Extension | GA |
| az iot ops dataflow list |
List dataflows associated with a dataflow profile. |
Extension | GA |
| az iot ops dataflow profile |
Dataflow profile management. |
Extension | GA |
| az iot ops dataflow profile create |
Create or replace a dataflow profile. |
Extension | GA |
| az iot ops dataflow profile delete |
Delete a dataflow profile. |
Extension | GA |
| az iot ops dataflow profile list |
List dataflow profiles associated with an instance. |
Extension | GA |
| az iot ops dataflow profile show |
Show details of a dataflow profile. |
Extension | GA |
| az iot ops dataflow profile update |
Update a dataflow profile. |
Extension | GA |
| az iot ops dataflow show |
Show details of a dataflow associated with a dataflow profile. |
Extension | GA |
| az iot ops delete |
Delete IoT Operations from the cluster. |
Extension | GA |
| az iot ops get-versions |
Opens the version guide located at https://aka.ms/aio-versions in the default browser. |
Extension | Experimental |
| az iot ops identity |
Instance identity management. |
Extension | GA |
| az iot ops identity assign |
Assign a user-assigned managed identity with the instance. |
Extension | GA |
| az iot ops identity remove |
Remove a user-assigned managed identity from the instance. |
Extension | GA |
| az iot ops identity show |
Show the instance identities. |
Extension | GA |
| az iot ops init |
Bootstrap the Arc-enabled cluster for IoT Operations deployment. |
Extension | GA |
| az iot ops list |
List IoT Operations instances. |
Extension | GA |
| az iot ops ns |
Device Registry Namespaces management. |
Extension | Preview |
| az iot ops ns asset |
Manage namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom |
Manage namespaced assets that point to custom device endpoints. |
Extension | Preview |
| az iot ops ns asset custom create |
Create a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset |
Manage datasets for custom namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset add |
Add a dataset to a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset list |
List datasets for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset point |
Manage data points for custom asset datasets in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns asset custom dataset point add |
Add a data point to a custom asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom dataset point list |
List data points for a custom asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom dataset point remove |
Remove a data point from a custom asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom dataset remove |
Remove a dataset from a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset show |
Show details of a dataset for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom dataset update |
Update a dataset for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event |
Manage events for custom namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event add |
Add an event to a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event list |
List events for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event point |
Manage event points for custom asset events in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns asset custom event point add |
Add an event data point to a custom asset event in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom event point list |
List event points for a custom asset event in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom event point remove |
Remove an event point from a custom asset event in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset custom event remove |
Remove an event from a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event show |
Show details of an event for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom event update |
Update an event for a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom mgmt |
Manage custom asset management groups in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom mgmt action |
Manage actions within custom asset management groups. |
Extension | Preview |
| az iot ops ns asset custom mgmt action add |
Add an action to a custom asset management group. |
Extension | Preview |
| az iot ops ns asset custom mgmt action list |
List actions in a custom asset management group. |
Extension | Preview |
| az iot ops ns asset custom mgmt action remove |
Remove an action from a custom asset management group. |
Extension | Preview |
| az iot ops ns asset custom mgmt add |
Add a management group to a custom asset. |
Extension | Preview |
| az iot ops ns asset custom mgmt list |
List management groups for a custom asset. |
Extension | Preview |
| az iot ops ns asset custom mgmt remove |
Remove a management group from a custom asset. |
Extension | Preview |
| az iot ops ns asset custom mgmt show |
Show details of a management group for a custom asset. |
Extension | Preview |
| az iot ops ns asset custom mgmt update |
Update a management group for a custom asset. |
Extension | Preview |
| az iot ops ns asset custom stream |
Manage streams for custom namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset custom stream add |
Add a stream to a custom asset. |
Extension | Preview |
| az iot ops ns asset custom stream list |
List streams in a custom asset. |
Extension | Preview |
| az iot ops ns asset custom stream remove |
Remove a stream from a custom asset. |
Extension | Preview |
| az iot ops ns asset custom stream show |
Show details of a stream in a custom asset. |
Extension | Preview |
| az iot ops ns asset custom stream update |
Update a stream in a custom asset. |
Extension | Preview |
| az iot ops ns asset custom update |
Update a custom namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset delete |
Delete a namespaced asset from an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset media |
Manage namespaced assets that point to media device endpoints. |
Extension | Preview |
| az iot ops ns asset media create |
Create a media namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset media stream |
Manage streams for media namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset media stream add |
Add a stream to a media asset. |
Extension | Preview |
| az iot ops ns asset media stream list |
List streams in a media asset. |
Extension | Preview |
| az iot ops ns asset media stream remove |
Remove a stream from a media asset. |
Extension | Preview |
| az iot ops ns asset media stream show |
Show details of a stream in a media asset. |
Extension | Preview |
| az iot ops ns asset media stream update |
Update a stream in a media asset. |
Extension | Preview |
| az iot ops ns asset media update |
Update a media namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif |
Manage namespaced assets that point to ONVIF device endpoints. |
Extension | Preview |
| az iot ops ns asset onvif create |
Create an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event |
Manage events for ONVIF namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event add |
Add an event to an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event list |
List events for an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event remove |
Remove an event from an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event show |
Show details of an event for an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif event update |
Update an event for an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif mgmt |
Manage ONVIF asset management groups in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset onvif mgmt add |
Add a management group to an ONVIF asset. |
Extension | Preview |
| az iot ops ns asset onvif mgmt list |
List management groups for an ONVIF asset. |
Extension | Preview |
| az iot ops ns asset onvif mgmt remove |
Remove a management group from an ONVIF asset. |
Extension | Preview |
| az iot ops ns asset onvif mgmt show |
Show details of a management group for an ONVIF asset. |
Extension | Preview |
| az iot ops ns asset onvif mgmt update |
Update a management group for an ONVIF asset. |
Extension | Preview |
| az iot ops ns asset onvif update |
Update an ONVIF namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua |
Manage namespaced assets that point to OPC UA device endpoints. |
Extension | Preview |
| az iot ops ns asset opcua create |
Create an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset |
Manage datasets for OPC UA namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset add |
Add a dataset to an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset list |
List datasets for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset point |
Manage data points for OPC UA asset datasets in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns asset opcua dataset point add |
Add a data point to an OPC UA asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset opcua dataset point list |
List data points for an OPC UA asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset opcua dataset point remove |
Remove a data point from an OPC UA asset dataset in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns asset opcua dataset remove |
Remove a dataset from an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset show |
Show details of a dataset for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua dataset update |
Update a dataset for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event |
Manage events for OPC UA namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event add |
Add an event to an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event list |
List events for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event remove |
Remove an event from an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event show |
Show details of an event for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua event update |
Update an event for an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset opcua mgmt |
Manage OPC UA asset management groups in an IoT Operations instance. |
Extension | Preview |
| 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 update |
Update an OPC UA namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset query |
Query namespaced assets. |
Extension | Preview |
| az iot ops ns asset rest |
Manage namespaced assets that point to REST device endpoints. |
Extension | Preview |
| az iot ops ns asset rest create |
Create a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset |
Manage datasets for REST namespaced assets in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset add |
Add a dataset to a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset list |
List datasets for a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset remove |
Remove a dataset from a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset show |
Show details of a dataset for a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest dataset update |
Update a dataset for a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset rest update |
Update a REST namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns asset show |
Show details of a namespaced asset in an IoT Operations instance. |
Extension | Preview |
| az iot ops ns create |
Create a Device Registry namespace. |
Extension | Preview |
| az iot ops ns delete |
Delete a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device |
Manage devices in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns device create |
Create a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device delete |
Delete a device from a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint |
Manage endpoints for devices in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns device endpoint inbound |
Manage inbound endpoints for devices in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns device endpoint inbound add |
Add inbound endpoints to devices in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns device endpoint inbound add custom |
Add a custom inbound endpoint to a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound add media |
Add a media inbound endpoint to a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound add onvif |
Add an ONVIF inbound endpoint to a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound add opcua |
Add an OPC UA inbound endpoint to a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound add rest |
Add a rest inbound endpoint to a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound list |
List inbound endpoints of a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint inbound remove |
Remove inbound endpoints from a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device endpoint list |
List all endpoints of a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device query |
Query devices in Device Registry namespaces. |
Extension | Preview |
| az iot ops ns device show |
Show details of a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns device update |
Update a device in a Device Registry namespace. |
Extension | Preview |
| az iot ops ns list |
List Device Registry namespaces. |
Extension | Preview |
| az iot ops ns show |
Show details of a Device Registry namespace. |
Extension | Preview |
| az iot ops ns update |
Update a Device Registry namespace. |
Extension | Preview |
| az iot ops registry |
Manage container registry endpoints. |
Extension | Preview |
| az iot ops registry add |
Add a container registry endpoint to an instance. |
Extension | Preview |
| az iot ops registry list |
List configured container registry endpoints. |
Extension | Preview |
| az iot ops registry remove |
Remove a container registry endpoint. |
Extension | Preview |
| az iot ops registry show |
Show details of a container registry endpoint. |
Extension | Preview |
| az iot ops registry update |
Update a container registry endpoint. |
Extension | Preview |
| az iot ops rsync |
Resource sync rules management. |
Extension | Preview |
| az iot ops rsync disable |
Disable edge to cloud hydration by deleting instance associated resource sync rules. |
Extension | Preview |
| az iot ops rsync enable |
Enable edge to cloud hydration by creating resource sync rules for the instance. |
Extension | Preview |
| az iot ops rsync list |
List resource sync rules associated with the instance. |
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 | Experimental |
| 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 | GA |
| 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 | GA |
| az iot ops upgrade |
Upgrade an IoT Operations instance. |
Extension | GA |
az iot ops check
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Evaluate cluster-side readiness and runtime health of deployed IoT Operations services.
The command by default shows a high-level human friendly summary view of all services.
Use the '--svc' option to specify checks for a single service, and configure verbosity via the --detail-level argument.
Note: Resource kind (--resources) and name (--resource-name) filtering can only be used with the '--svc' argument.
{Supported service APIs}
- deviceregistry.microsoft.com/[v1,v1beta1]
- namespaces.deviceregistry.microsoft.com/[v1beta1]
- mqttbroker.iotoperations.azure.com/[v1,v1beta1]
- connectivity.iotoperations.azure.com/[v1,v1beta1]
For more information on cluster requirements, please check https://aka.ms/iot-ops-cluster-requirements.
az iot ops check [--as-object {false, true}]
[--context]
[--detail-level {0, 1, 2}]
[--ops-service --svc {akri, broker, dataflow, deviceregistry, opcua}]
[--post {false, true}]
[--pre {false, true}]
[--resource-name --rn]
[--resources {asset, assetendpointprofile, broker, brokerauthentication, brokerauthorization, brokerlistener, dataflow, dataflowendpoint, dataflowprofile, registryendpoint}]Examples
Basic usage. Checks overall IoT Operations health with summary output.
az iot ops checkChecks `broker` service health and configuration with detailed output.
az iot ops check --svc broker --detail-level 1Evaluate only the `dataflow` service with output optimized for CI.
az iot ops check --svc dataflow --as-objectChecks `deviceregistry` health with verbose output, but constrains results to `asset` resources.
az iot ops check --svc deviceregistry --detail-level 2 --resources assetUse 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Output check content and validations in a CI friendly data structure.
| Property | Value |
|---|---|
| Parameter group: | Format Arguments |
| Accepted values: | false, true |
Kubeconfig context name to use for k8s cluster communication. If no context is provided current_context is used.
| Property | Value |
|---|---|
| Parameter group: | K8s Cluster Arguments |
Controls the level of detail displayed in the check output. Choose 0 for a summary view (minimal output), 1 for a detailed view (more comprehensive information), or 2 for a verbose view (all available information).
| Property | Value |
|---|---|
| Default value: | 0 |
| Accepted values: | 0, 1, 2 |
The IoT Operations service deployment that will be evaluated.
| Property | Value |
|---|---|
| Accepted values: | akri, broker, dataflow, deviceregistry, opcua |
Run post-deployment checks.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Run pre-requisite checks to determine if the minimum requirements of a service deployment are fulfilled.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Only run checks for the specific resource name. The name is case insensitive. Glob patterns '' and '?' are supported. Note: Only alphanumeric characters, hyphens, '?' and '' are allowed.
Only run checks on specific resource kinds. Use space-separated values.
| Property | Value |
|---|---|
| Accepted values: | asset, assetendpointprofile, broker, brokerauthentication, brokerauthorization, brokerlistener, dataflow, dataflowendpoint, dataflowprofile, registryendpoint |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops clone
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Clone an instance.
Clone analyzes an instance then reproduces it in an infrastructure-as-code manner via ARM templates.
The output of clone may be applied directly to another connected cluster (referred to as replication), and/or saved locally to use at another time with potential modification.
The clone definition being a generic ARM template, can be deployed via existing tools. See https://aka.ms/aio-clone for details.
Clone is compatible with the following instance version range: 1.0.34>=,<1.3.0.
az iot ops clone --name
--resource-group
[--base-uri]
[--force {false, true}]
[--mode {linked, nested}]
[--no-progress {false, true}]
[--param]
[--self-hosted-issuer {false, true}]
[--summary {detailed, simple}]
[--to-cluster-id]
[--to-dir]
[--yes {false, true}]Examples
Clone an instance to a desired connected cluster.
az iot ops clone -n myinstance -g myresourcegroup --to-cluster-id $CLUSTER_RESOURCE_IDClone an instance to a desired connected cluster, with customized replication.
az iot ops clone -n myinstance -g myresourcegroup --to-cluster-id $CLUSTER_RESOURCE_ID --param ___location=eastusClone an instance to a desired connected cluster, but splitting and serially applying asset related sub-deployments.
az iot ops clone -n myinstance -g myresourcegroup --to-cluster-id $CLUSTER_RESOURCE_ID --mode linkedClone an instance to a local directory.
az iot ops clone -n myinstance -g myresourcegroup --to-dir .Clone an instance to a local directory, but splitting and linking to asset related sub-deployments.
az iot ops clone -n myinstance -g myresourcegroup --to-dir /my/content --mode linkedHide progress displays and skip prompts.
az iot ops clone -n myinstance -g myresourcegroup --to-dir . --no-progress -yRequired Parameters
The model instance to clone.
The resource group the model instance to clone resides in.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Base URI to use for template links. If not provided a relative path strategy will be used. Relevant when --mode is set to 'linked'. Example: https://raw.githubusercontent.com/myorg/myproject/main/myclones/.
| Property | Value |
|---|---|
| Parameter group: | Local Target Arguments |
Force the operation to execute.
| Property | Value |
|---|---|
| Accepted values: | false, true |
When mode 'nested' is used, sub-deployments will be self-contained in the root deployment. When mode 'linked' is used, asset related sub-deployments will be split and stored as separate files linked by the root deployment.
| Property | Value |
|---|---|
| Default value: | nested |
| Accepted values: | linked, nested |
Disable visual representation of work.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Parameter overrides when replicating the clone to a connected cluster. If omitted default values from the model instance are used. Format is space-separated key=value pairs where the key represents a clone definition parameter. The following keys can be set: instanceName, clusterName, clusterNamespace, customLocationName, opsExtensionName, schemaRegistryId, resourceSlug, ___location, applyRoleAssignments, adrNamespaceId. Can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Cluster Target Arguments |
Use the self-hosted oidc issuer for federation. Only applicable if user-assigned managed identities are associated to the model instance.
| Property | Value |
|---|---|
| Parameter group: | Cluster Target Arguments |
| Accepted values: | false, true |
Deployment summary option.
| Property | Value |
|---|---|
| Default value: | simple |
| Accepted values: | detailed, simple |
The resource Id of the connected cluster the clone will be applied to.
| Property | Value |
|---|---|
| Parameter group: | Cluster Target Arguments |
The local directory the instance clone definitions will be stored in.
| Property | Value |
|---|---|
| Parameter group: | Local Target Arguments |
Confirm [y]es without a prompt. Useful for CI and automation scenarios.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops create
Create an IoT Operations instance.
A succesful execution of init is required before running this command.
The result of the command nets an IoT Operations instance with a set of default resources configured for cohesive function.
To enable broker disk persistence at least a value for --persist-max-size must be provided. When enabled the default configuration is constrained to dynamic persistence across state store, retain messages and subscriber queues.
To enable edge to cloud resource hydration please use the
az iot ops rsync enable command post instance creation.
az iot ops create --cluster
--name
--ns-resource-id
--resource-group
--sr-resource-id
[--add-insecure-listener {false, true}]
[--bp --broker-backend-part]
[--br --broker-backend-rf]
[--broker-backend-workers --bw]
[--broker-config-file]
[--broker-frontend-replicas --fr]
[--broker-frontend-workers --fw]
[--broker-mem-profile --mp {High, Low, Medium, Tiny}]
[--cluster-namespace]
[--custom-___location]
[--description]
[--df-profile-instances]
[--feature]
[--___location]
[--no-progress {false, true}]
[--ops-config]
[--persist-max-size]
[--persist-mode]
[--persist-pvc-sc]
[--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 --ns-resource-id $NAMESPACE_RESOURCE_IDThe 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 --ns-resource-id $NAMESPACE_RESOURCE_ID --broker-mem-profile High --broker-backend-workers 4 --description 'Contoso Factory' --tags tier=testX1This 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 --ns-resource-id $NAMESPACE_RESOURCE_ID --add-insecure-listenerThis 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 --ns-resource-id $NAMESPACE_RESOURCE_ID --trust-settings configMapName=example-bundle configMapKey=trust-bundle.pem issuerKind=ClusterIssuer issuerName=trust-manager-selfsigned-issuerDeploy the mqtt broker with the min options to enable disk persistence.
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --ns-resource-id $NAMESPACE_RESOURCE_ID --persist-max-size 10GiDeploy the mqtt broker with disk persistence, configuring volume claim storage class and persistence mode.
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --ns-resource-id $NAMESPACE_RESOURCE_ID --persist-max-size 10Gi --persist-pvc-sc mystorageclass --persist-mode retain=All stateStore=NoneRequired Parameters
Target cluster name for IoT Operations deployment.
IoT Operations instance name.
The device registry namespace resource Id to use with IoT Operations.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The schema registry resource Id to use with IoT Operations.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
When enabled the mqtt broker deployment will include a listener of service type LoadBalancer, bound to port 1883 with no authN or authZ. For non-production workloads only.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Accepted values: | false, true |
Mqtt broker backend partitions. Min value: 1, max value: 16.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | 2 |
Mqtt broker backend redundancy factor. Indicates the desired numbers of backend replicas (pods) in a physical partition. Min value: 1, max value: 5.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | 2 |
Mqtt broker backend workers. Min value: 1, max value: 16.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | 2 |
Path to a json file with custom broker config properties. File config content is used over individual broker config parameters. Useful for advanced scenarios. The expected format is described at https://aka.ms/aziotops-broker-config.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
Mqtt broker frontend replicas. Min value: 1, max value: 16.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | 2 |
Mqtt broker frontend workers. Min value: 1, max value: 16.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | 2 |
Mqtt broker memory profile.
| Property | Value |
|---|---|
| Parameter group: | Broker Arguments |
| Default value: | Medium |
| Accepted values: | High, Low, Medium, Tiny |
The cluster namespace IoT Operations infra will be deployed to. Must be lowercase.
| Property | Value |
|---|---|
| Default value: | azure-iot-operations |
The custom ___location name corresponding to the IoT Operations deployment. The default is in the form '___location-{hash(5)}'.
Description of the IoT Operations instance.
The instance count associated with the default dataflow profile.
| Property | Value |
|---|---|
| Parameter group: | Dataflow Arguments |
| Default value: | 1 |
Instance feature config. The settings of a component and/or it's mode can be configured. Component mode syntax is {component}.mode={mode} where known mode values are: Stable, Preview and Disabled. Component setting syntax is {component}.settings.{setting}={value} where known setting values are Enabled or Disabled. This option can be used one or more times.
The region that will be used for provisioned resource collateral. If not provided the connected cluster ___location will be used.
Disable visual representation of work.
| Property | Value |
|---|---|
| Accepted values: | false, true |
IotOperations arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
The max size of the message buffer on disk. Setting a value will enable disk persistence. Kubernetes resource units must be used e.g. the following value suffixes are supported: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
| Property | Value |
|---|---|
| Parameter group: | Disk Persistence Arguments |
Configure disk persistence mode for state store, retain messages and subscriber queues. Format is space-separated key=value pairs. Supported keys include: 'stateStore', 'retain', 'subscriberQueue'. Supported values for each key include: 'None', 'All', 'Custom'. By default each mode is set to min Custom with dynamic persistence enabled. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Disk Persistence Arguments |
Name of the storage class required by the persistent volume claim.
| Property | Value |
|---|---|
| Parameter group: | Disk Persistence Arguments |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Settings for user provided trust bundle. Used for component TLS. Format is space-separated key=value pairs. The following keys are required: issuerName, issuerKind, configMapName, configMapKey. If not used, a system provided self-signed trust bundle is configured.
| Property | Value |
|---|---|
| Parameter group: | Trust Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops delete
Delete IoT Operations from the cluster.
The name of either the instance or cluster must be provided.
The operation uses Azure Resource Graph to determine correlated resources. Resource Graph being eventually consistent does not guarantee a synchronized state at the time of execution.
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 myresourcegroupSkip confirmation prompt and continue to deletion process. Useful for CI scenarios.
az iot ops delete -n myinstance -g myresourcegroup -yForce deletion regardless of warnings. May lead to errors.
az iot ops delete -n myinstance -g myresourcegroup --forceUse cluster name instead of instance for lookup.
az iot ops delete --cluster mycluster -g myresourcegroupReverse application of init.
az iot ops delete -n myinstance -g myresourcegroup --include-depsRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Target cluster name for IoT Operations deletion.
Force the operation to execute.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Indicates the command should remove IoT Operations dependencies. This option is intended to reverse the application of init.
| Property | Value |
|---|---|
| Accepted values: | false, true |
IoT Operations instance name.
Disable visual representation of work.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Confirm [y]es without a prompt. Useful for CI and automation scenarios.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops get-versions
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Opens the version guide located at https://aka.ms/aio-versions in the default browser.
az iot ops get-versionsExamples
Route to the version guide in a new browser window.
az iot ops get-versionsGlobal Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops init
Bootstrap the Arc-enabled cluster for IoT Operations deployment.
An Arc-enabled cluster is required to deploy IoT Operations. See the following resource for more info https://aka.ms/aziotops-arcconnect.
The init operation will do work in installing and configuring a foundation layer of edge services necessary for IoT Operations deployment.
After the foundation layer has been installed the az iot ops create command should
be used to deploy an instance.
Note: --*-config options allow override of default config settings.
The default config settings for container storage are: edgeStorageConfiguration.create=true feature.diskStorageClass=default,local-path
If --enable-fault-tolerance is used the following config delta applies to container storage: feature.diskStorageClass=acstor-arccontainerstorage-storage-pool acstorConfiguration.create=true acstorConfiguration.properties.diskMountPoint=/mnt
The default config settings for secret store are: rotationPollIntervalInSeconds=120 validatingAdmissionPolicies.applyPolicies=false.
az iot ops init --cluster
--resource-group
[--acs-config]
[--check-cluster {false, true}]
[--context]
[--enable-fault-tolerance {false, true}]
[--ensure-latest {false, true}]
[--no-progress {false, true}]
[--ssc-config]
[--user-trust --ut {false, true}]Examples
Usage with minimum input. This form will deploy the IoT Operations foundation layer.
az iot ops init --cluster mycluster -g myresourcegroupSimilar 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-toleranceThis 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-trustProvide custom deploy-time configs for Arc Container Storage.
az iot ops init --cluster mycluster -g myresourcegroup --enable-fault-tolerance --acs-config acstorConfiguration.properties.diskMountPoint=/mntProvide custom deploy-time configs for Arc Secret Store.
az iot ops init --cluster mycluster -g myresourcegroup --ssc-config rotationPollIntervalInSeconds=60Check if the cluster meets necessary prerequisite configuration before continuing with init. A valid kubeconfig is required with this option.
az iot ops init --cluster mycluster -g myresourcegroup --check-clusterRequired Parameters
Target cluster name for IoT Operations deployment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ContainerStorage arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
Enforce a check for minimum cluster requirements before bootstrapping.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Kubeconfig context name to use for k8s cluster communication. If no context is provided current_context is used.
| Property | Value |
|---|---|
| Parameter group: | K8s Cluster Arguments |
Enable fault tolerance for Azure Arc Container Storage. At least 3 cluster nodes are required.
| Property | Value |
|---|---|
| Parameter group: | Container Storage Arguments |
| Accepted values: | false, true |
Ensure the latest IoT Ops CLI is being used, raising an error if an upgrade is available.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Disable visual representation of work.
| Property | Value |
|---|---|
| Accepted values: | false, true |
SecretStore arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
Skip the deployment of the system cert-manager and trust-manager in favor of a user-provided configuration.
| Property | Value |
|---|---|
| Parameter group: | Trust Arguments |
| Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops list
List IoT Operations instances.
Use --query with desired JMESPath syntax to query the result.
az iot ops list [--resource-group]Examples
List all instances in the subscription.
az iot ops listList all instances of a particular resource group.
az iot ops list -g myresourcegroupList the instances in the subscription that have a particular tag value.
az iot ops list -g myresourcegroup --query "[?tags.env == 'prod']"Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops show
Show an IoT Operations instance.
Optionally the command can output a tree structure of associated resources representing the IoT Operations deployment against the backing cluster.
az iot ops show --name
--resource-group
[--tree {false, true}]Examples
Basic usage to show an instance.
az iot ops show --name myinstance -g myresourcegroupOutput a tree structure of associated resources representing the IoT Operations deployment.
az iot ops show --name myinstance -g myresourcegroup --treeRequired Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Use to visualize the IoT Operations deployment against the backing cluster.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops update
Update an IoT Operations instance.
Currently instance tags, description and features can be updated.
az iot ops update --name
--resource-group
[--description]
[--feature]
[--tags]Examples
Update instance tags. This is equivalent to a replace.
az iot ops update --name myinstance -g myresourcegroup --tags a=b c=dRemove 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
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Description of the IoT Operations instance.
Instance feature config. The settings of a component and/or it's mode can be configured. Component mode syntax is {component}.mode={mode} where known mode values are: Stable, Preview and Disabled. Component setting syntax is {component}.settings.{setting}={value} where known setting values are Enabled or Disabled. This option can be used one or more times.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az iot ops upgrade
Upgrade an IoT Operations instance.
By default, with no options, the command will evaluate versions of the
deployed cluster side services that make up IoT Operations and compare them
with the built-in deployment that would be executed with az iot ops init
and az iot ops create.
az iot ops upgrade --name
--resource-group
[--acs-config]
[--no-progress {false, true}]
[--ops-config]
[--plat-config]
[--ssc-config]
[--yes {false, true}]Examples
Upgrade the instance with minimal inputs.
az iot ops upgrade --name myinstance -g myresourcegroupSkip the confirmation prompt for instance upgrade. Useful for CI scenarios.
az iot ops upgrade --name myinstance -g myresourcegroup -ySet extension config settings that apply should be during upgrade. To remove a setting provide the key with no value.
az iot ops upgrade --name myinstance -g myresourcegroup --ops-config key1=value1 deletekeyRequired Parameters
IoT Operations instance name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ContainerStorage arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
Disable visual representation of work.
| Property | Value |
|---|---|
| Accepted values: | false, true |
IotOperations arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
Platform arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
SecretStore arc extension custom config. Format is space-separated key=value pairs or just the key. This option can be used one or more times.
| Property | Value |
|---|---|
| Parameter group: | Extension Config Arguments |
Confirm [y]es without a prompt. Useful for CI and automation scenarios.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
