You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-operations/deploy-iot-ops/howto-upgrade.md
+35-10Lines changed: 35 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,27 @@ ms.date: 11/11/2024
12
12
13
13
# Upgrade or downgrade between versions
14
14
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.
16
16
17
17
## Prerequisites
18
18
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
+
19
27
## Understand upgrade support
20
28
21
29
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:
22
30
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 |
27
36
28
37
## Upgrade
29
38
@@ -33,7 +42,7 @@ You can't upgrade from a preview installation to a GA version. To move to versio
33
42
34
43
### [Azure portal](#tab/portal)
35
44
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.
37
46
38
47
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure IoT Operations instance.
39
48
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
48
57
49
58
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.
50
59
51
-
### [Azure CLI](#tab/cli)
60
+
### [Azure CLI](#tab/cli)
52
61
53
62
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.
54
63
55
64
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.
56
65
57
-
---
66
+
```azurecli
67
+
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME>
68
+
```
58
69
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:
60
73
74
+
```azurecli
75
+
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME> --acs-version 2.2.3
76
+
```
61
77
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
62
83
63
84
### [Azure portal](#tab/portal)
64
85
65
86
The Azure portal doesn't offer a version downgrade option. Instead, use the Azure CLI.
66
87
67
-
### [Azure CLI](#tab/cli)
88
+
### [Azure CLI](#tab/cli)
68
89
69
90
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.
70
91
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).
0 commit comments