Skip to content

Commit 2878c46

Browse files
committed
Add upgrade/downgrade steps for IoT Ops
1 parent f328898 commit 2878c46

File tree

4 files changed

+50
-12
lines changed

4 files changed

+50
-12
lines changed

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

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,62 @@ ms.date: 11/11/2024
1010
#CustomerIntent: As an OT professional, I want to manage Azure IoT Operations instances.
1111
---
1212

13-
# Upgrade or rollback between versions
13+
# Upgrade or downgrade between versions
1414

1515
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.
1616

17-
>[!NOTE]
18-
>Currently, Azure IoT Operations has only one generally available version. Upgrade and rollback will be available once there are additional versions to upgrade or rollback between.
17+
## Prerequisites
1918

2019
## Understand upgrade support
2120

22-
Upgrade and rollback are supported between N+2 or N-2 minor versions of Azure IoT Operations, or between any patch versions of the same minor version. The following table provides examples:
21+
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:
2322

24-
| Current version | Upgrade range | Rollback range |
25-
| --------------- | ------------- | -------------- |
26-
| 1.0.0 | 1.0.1 through 1.2.x | None |
27-
| 1.1.0 | 1.1.1 through 1.3.x | 1.0.x |
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 |
2827

2928
## Upgrade
3029

3130
Azure IoT Operations supports upgrading instances to new GA versions as they're released.
3231

3332
You can't upgrade from a preview installation to a GA version. To move to version 1.0.x, [uninstall Azure IoT Operations](howto-manage-update-uninstall.md#uninstall) and reinstall the new version.
33+
34+
### [Azure portal](#tab/portal)
35+
36+
If your instance is eligible for an upgrade, the Azure portal displays an **Upgrade** option.
37+
38+
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure IoT Operations instance.
39+
1. Select **Upgrade** on the **Overview** page of your instance.
40+
41+
:::image type="content" source="./media/howto-upgrade/instance-upgrade.png" alt-text="Screenshot that shows the upgrade button enabled in the Azure portal.":::
42+
43+
1. The portal presents the Azure CLI command to upgrade your instance, prepopulated with your subscription, resource group, and instance details. Select the copy icon next to the CLI command.
44+
45+
1. Run the copied `az iot ops upgrade` command in any environment where you have the Azure CLI installed.
46+
47+
1. After the upgrade command completes successfully, refresh your instance to see the changes.
48+
49+
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+
51+
### [Azure CLI](#tab/cli)
52+
53+
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+
55+
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+
57+
---
58+
59+
## Downgrade
60+
61+
62+
63+
### [Azure portal](#tab/portal)
64+
65+
The Azure portal doesn't offer a version downgrade option. Instead, use the Azure CLI.
66+
67+
### [Azure CLI](#tab/cli)
68+
69+
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+
71+
---
57.4 KB
Loading

articles/iot-operations/get-started-end-to-end-sample/quickstart-deploy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: kgremban
55
ms.author: kgremban
66
ms.topic: quickstart
77
ms.custom: ignite-2023, devx-track-azurecli
8-
ms.date: 10/22/2024
8+
ms.date: 01/30/2025
99

1010
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
1111
---
@@ -166,8 +166,8 @@ Run the following CLI commands in your Codespaces terminal.
166166
| Placeholder | Value |
167167
| ----------- | ----- |
168168
| <STORAGE_ACCOUNT_NAME> | A name for your storage account. Storage account names must be between 3 and 24 characters in length and only contain numbers and lowercase letters. |
169-
| <SCHEMA_REGISTRY_NAME> | A name for your schema registry. |
170-
| <SCHEMA_REGISTRY_NAMESPACE> | A name for your schema registry namespace. The namespace uniquely identifies a schema registry within a tenant. |
169+
| <SCHEMA_REGISTRY_NAME> | A name for your schema registry. Schema registry names can only contain numbers, lowercase letters, and hyphens. |
170+
| <SCHEMA_REGISTRY_NAMESPACE> | A name for your schema registry namespace. The namespace uniquely identifies a schema registry within a tenant. Schema registry namespace names can only contain numbers, lowercase letters, and hyphens. |
171171

172172
```azurecli
173173
STORAGE_ACCOUNT=<STORAGE_ACCOUNT_NAME>

articles/iot-operations/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ items:
2323
href: deploy-iot-ops/howto-deploy-iot-operations.md
2424
- name: Manage, update, or uninstall
2525
href: deploy-iot-ops/howto-manage-update-uninstall.md
26-
- name: Upgrade or rollback versions
26+
- name: Upgrade versions
2727
href: deploy-iot-ops/howto-upgrade.md
2828
- name: Enable secure settings
2929
href: deploy-iot-ops/howto-enable-secure-settings.md

0 commit comments

Comments
 (0)