Skip to content

Commit 8ed7a7d

Browse files
committed
Add CLI details
1 parent 2878c46 commit 8ed7a7d

File tree

1 file changed

+35
-10
lines changed

1 file changed

+35
-10
lines changed

articles/iot-operations/deploy-iot-ops/howto-upgrade.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,27 @@ ms.date: 11/11/2024
1212

1313
# Upgrade or downgrade between versions
1414

15-
Upgrade an Azure IoT Operations instance to a newer version or rollback to a previous version. Azure IoT Operations supports upgrade and rollback from version 1.0.x onwards. There is no support for upgrading from any preview version of Azure IoT Operations to any generally available (GA) version.
15+
Upgrade an Azure IoT Operations deployment to a newer version or rollback to a previous version. Azure IoT Operations supports upgrade and rollback from version 1.0.x onwards. There is no support for upgrading from any preview version of Azure IoT Operations to any generally available (GA) version.
1616

1717
## Prerequisites
1818

19+
* Azure CLI. This scenario requires Azure CLI version 2.64.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [Get started with Azure CLI](/cli/azure/get-started-with-azure-cli).
20+
21+
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
22+
23+
```azurecli
24+
az extension add --upgrade --name azure-iot-ops
25+
```
26+
1927
## Understand upgrade support
2028

2129
Upgrade and rollback are supported between N+3 or N-3 minor versions of Azure IoT Operations, or between any patch versions of the same minor version. The following table provides examples:
2230

23-
| Version | Upgrade range | Rollback range |
24-
| ------- | ------------- | -------------- |
25-
| 1.0.0 | 1.0.1 through 1.2.x | None |
26-
| 1.1.0 | 1.1.1 through 1.3.x | 1.0.x |
31+
| Version | Upgrade range | Downgrade range |
32+
| ------- | ------------- | --------------- |
33+
| 1.0.0 | 1.0.1 through 1.3.x | None |
34+
| 1.1.0 | 1.1.1 through 1.4.x | 1.0.x |
35+
| 1.4.4 | 1.4.5 through 1.7.x | 1.1.0 through 1.4.3 |
2736

2837
## Upgrade
2938

@@ -33,7 +42,7 @@ You can't upgrade from a preview installation to a GA version. To move to versio
3342

3443
### [Azure portal](#tab/portal)
3544

36-
If your instance is eligible for an upgrade, the Azure portal displays an **Upgrade** option.
45+
If your Azure IoT Operations deployment is eligible for an upgrade, the Azure portal displays an **Upgrade** option. If you don't see the option to upgrade, then your deployment is on the latest version.
3746

3847
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure IoT Operations instance.
3948
1. Select **Upgrade** on the **Overview** page of your instance.
@@ -48,24 +57,40 @@ If your instance is eligible for an upgrade, the Azure portal displays an **Upgr
4857

4958
The **Version** value displayed on your instance's overview page reflects the version of the Azure IoT Operations instance. However, you may be prompted to upgrade if a required Arc extension has an available upgrade. You can tell that an upgrade was successful if the **Upgrade** option disappears from the instance overview page, even if it doesn't look like anything changed. You can check the versions of the Arc extensions for your Azure IoT Operation deployment on the **Extensions** page of your Arc-enabled cluster in the Azure portal.
5059

51-
### [Azure CLI](#tab/cli)
60+
### [Azure CLI](#tab/cli)
5261

5362
Use the [az iot ops upgrade](/cli/azure/iot/ops#az-iot-ops-upgrade) command to upgrade an existing Azure IoT Operations deployment to a newer version.
5463

5564
The upgrade command evaluates the entire Azure IoT Operations deployment for available updates, including the arc extensions that are installed in the `az iot ops init` command as well as the Azure IoT Operations instance.
5665

57-
---
66+
```azurecli
67+
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME>
68+
```
5869

59-
## Downgrade
70+
The CLI outputs a table of the components, if any, that have available upgrades. Enter `Y` to continue with the upgrade.
71+
72+
To upgrade to a specific version of a component, specify the version number in the parameters. For example:
6073

74+
```azurecli
75+
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME> --acs-version 2.2.3
76+
```
6177

78+
You can find the supported component versions and release train information in the **azure-iot-operations-enablement.json** file included in any given [Azure IoT Operations release](https://github.com/Azure/azure-iot-operations/releases).
79+
80+
---
81+
82+
## Downgrade
6283

6384
### [Azure portal](#tab/portal)
6485

6586
The Azure portal doesn't offer a version downgrade option. Instead, use the Azure CLI.
6687

67-
### [Azure CLI](#tab/cli)
88+
### [Azure CLI](#tab/cli)
6889

6990
Use the [az iot ops upgrade](/cli/azure/iot/ops#az-iot-ops-upgrade) command to roll back an existing Azure IoT Operations instance to a previous version.
7091

92+
In the upgrade command, you can specify a component version up to three minor versions older that the latest.
93+
94+
You can find the supported component versions and release train information in the **azure-iot-operations-enablement.json** file included in any given [Azure IoT Operations release](https://github.com/Azure/azure-iot-operations/releases).
95+
7196
---

0 commit comments

Comments
 (0)