Manage the lifecycle of an Azure IoT Operations instance

1. In the Azure portal, search for and select Azure IoT Operations.
2. Use the filters to view Azure IoT Operations instances based on subscription, resource group, and more.

Use the az iot ops list command to see all of the Azure IoT Operations instances in your subscription or resource group.

The basic command returns all instances in your subscription.

az iot ops list

To filter the results by resource group, add the --resource-group parameter.

az iot ops list --resource-group <RESOURCE_GROUP>

You can view your Azure IoT Operations instance in the Azure portal.

1. In the Azure portal, go to the resource group that contains your Azure IoT Operations instance, or search for and select Azure IoT Operations.

2. Select the name of your Azure IoT Operations instance.

3. On the Overview page of your instance, the Arc extensions table displays the resources that were deployed to your cluster.

   

Use the az iot ops show command to view the properties of an instance.

az iot ops show --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP>

You can also use the az iot ops show command to view the resources in your Azure IoT Operations deployment in the Azure CLI. Add the --tree flag to show a tree view of the deployment that includes the specified Azure IoT Operations instance.

az iot ops show --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --tree

The tree view of a deployment looks like the following example:

MyCluster
├── extensions
│   ├── akvsecretsprovider
│   ├── azure-iot-operations-ltwgs
│   └── azure-iot-operations-platform-ltwgs
└── customLocations
    └── MyCluster-cl
        ├── resourceSyncRules
        └── resources
            ├── MyCluster-ops-init-instance
            └── MyCluster-observability

You can run az iot ops check on your cluster to assess health and configurations of individual Azure IoT Operations components. By default, the command checks MQ but you can specify the service with --ops-service parameter.

1. In the Azure portal, go to the resource group that contains your Azure IoT Operations instance, or search for and select Azure IoT Operations.

2. Select the name of your Azure IoT Operations instance.

3. On the Overview page of your instance, select Add tags or edit to modify tags on your instance.

Use the az iot ops update command to edit the tags and description parameters of your Azure IoT Operations instance. The values provided in the update command replace any existing tags or description

az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --desc "<INSTANCE_DESCRIPTION>" --tags <TAG_NAME>=<TAG-VALUE> <TAG_NAME>=<TAG-VALUE>

To delete all tags on an instance, set the tags parameter to a null value. For example:

az iot ops update --name <INSTANCE_NAME> --resource-group --tags ""

1. In the Azure portal, go to the resource group that contains your Azure IoT Operations instance, or search for and select Azure IoT Operations.

2. Select the name of your Azure IoT Operations instance.

3. On the Overview page of your instance, select Delete.

4. Review the list of resources that are and aren't deleted as part of this operation, then type the name of your instance and select Delete to confirm.

   

Use the az iot ops delete command to delete the entire Azure IoT Operations deployment from a cluster. The delete command evaluates the Azure IoT Operations related resources on the cluster and presents a tree view of the resources to be deleted. The cluster should be online when you run this command.

The delete command streamlines the redeployment of Azure IoT Operations to the same cluster. It undoes the create command so that you can run create, delete, create again and so on without having to rerun init.

The delete command removes:

• The Azure IoT Operations instance
• Arc extensions
• Custom locations
• Resource sync rules
• Resources that you can configure in your Azure IoT Operations solution, like assets, MQTT broker, and dataflows.

az iot ops delete --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP>

To delete the instance and also remove the Azure IoT Operations dependencies (the output of init), add the flag --include-deps.

az iot ops delete --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --include-deps

1. In the Azure portal, go to the resource group that contains your Azure IoT Operations instance, or search for and select Azure IoT Operations.

2. Select the name of your Azure IoT Operations instance.

3. On the Overview page of your instance, select Upgrade.

4. The Upgrade Azure IoT Operations wizard prompts you to make sure you have the latest version for the Azure IoT Operations CLI extension. Copy and run the provided az extension add command.

5. Update to the latest version of Azure IoT Operations instance. Copy and run the provided az iot ops upgrade command.

6. Once the upgrade command completes successfully, you can exit the wizard and refresh your instance page.

Use the az iot ops upgrade command to upgrade an Azure IoT Operations deployment. This command:

• Upgrades Azure Arc extensions on your cluster.
• Upgrades the Azure IoT Operations instance.

az iot ops upgrade --resource-group <RESOURCE_GROUP> --name <INSTANCE_NAME>