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-hub-device-update/create-update-group.md
+25-15Lines changed: 25 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Manage device groups for Azure Device Update for IoT Hub | Microsoft Docs
3
3
description: Learn how to configure Azure Device Update for IoT Hub device groups by using tags in the Azure portal or with Azure CLI.
4
4
author: vimeht
5
5
ms.author: vimeht
6
-
ms.date: 01/10/2025
6
+
ms.date: 01/23/2025
7
7
ms.topic: how-to
8
8
ms.service: azure-iot-hub
9
9
ms.subservice: device-update
@@ -19,10 +19,31 @@ This article describes how to use the Azure portal or Azure CLI to create and ma
19
19
20
20
## Prerequisites
21
21
22
+
# [Azure portal](#tab/portal)
23
+
24
+
- A Standard (S1) or higher instance of [Azure IoT Hub](/azure/iot-hub/create-hub?tabs=portal) with [Device Update for IoT Hub enabled](create-device-update-account.md).
25
+
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub.
26
+
- The Device Update agent installed and started on the device either as a module- or device-level identity.
27
+
- An [imported update for the provisioned device](import-update.md).
28
+
29
+
# [Azure CLI](#tab/cli)
30
+
22
31
- A Standard (S1) or higher instance of [Azure IoT Hub](/azure/iot-hub/create-hub?tabs=portal) with [Device Update for IoT Hub enabled](create-device-update-account.md).
23
32
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub.
24
33
- The Device Update agent installed and started on the device either as a module- or device-level identity.
25
34
- An [imported update for the provisioned device](import-update.md).
35
+
- The Bash environment in [Azure Cloud Shell](/azure/cloud-shell/quickstart) to run the Azure CLI commands. Select **Launch Cloud Shell** to open Cloud Shell, or select the Cloud Shell icon in the top toolbar of the Azure portal.
36
+
37
+
:::image type="icon" source="~/reusable-content/ce-skilling/azure/media/cloud-shell/launch-cloud-shell-button.png" alt-text="Button to launch the Azure Cloud Shell." border="false" link="https://shell.azure.com":::
38
+
39
+
>[!NOTE]
40
+
>If you prefer, you can run the Azure CLI commands locally:
41
+
>
42
+
>1.[Install Azure CLI](/cli/azure/install-azure-cli). Run [az version](/cli/azure/reference-index#az-version) to see the installed Azure CLI version and dependent libraries, and run [az upgrade](/cli/azure/reference-index#az-upgrade) to install the latest version.
43
+
>1. Sign in to Azure by running [az login](/cli/azure/reference-index#az-login).
44
+
>1. Install the `azure-iot` extension when prompted on first use. To make sure you're using the latest version of the extension, run `az extension update --name azure-iot`.
45
+
46
+
---
26
47
27
48
## Add tags to your devices
28
49
@@ -87,17 +108,6 @@ You can also add or update the `ADUGroup` tag directly in the device or module t
87
108
88
109
# [Azure CLI](#tab/cli)
89
110
90
-
You can use the Bash environment in [Azure Cloud Shell](/azure/cloud-shell/quickstart) to run the following Azure CLI commands. Select **Launch Cloud Shell** to open Cloud Shell, or select the Cloud Shell icon in the top toolbar of the Azure portal.
91
-
92
-
:::image type="icon" source="~/reusable-content/ce-skilling/azure/media/cloud-shell/launch-cloud-shell-button.png" alt-text="Button to launch the Azure Cloud Shell." border="false" link="https://shell.azure.com":::
93
-
94
-
>[!NOTE]
95
-
>If you prefer, you can run the Azure CLI commands locally:
96
-
>
97
-
>1.[Install Azure CLI](/cli/azure/install-azure-cli). Run [az version](/cli/azure/reference-index#az-version) to see the installed Azure CLI version and dependent libraries, and run [az upgrade](/cli/azure/reference-index#az-upgrade) to install the latest version.
98
-
>1. Sign in to Azure by running [az login](/cli/azure/reference-index#az-login).
99
-
>1. Install the `azure-iot` extension when prompted on first use. To make sure you're using the latest version of the extension, run `az extension update --name azure-iot`.
100
-
101
111
Use [az iot hub device-twin update](/cli/azure/iot/hub/device-twin#az-iot-hub-device-twin-update) or [az iot hub module-twin update](/cli/azure/iot/hub/module-twin#az-iot-hub-module-twin-update) to add the `ADUGroup` tag to the device or module twin with an appropriate value. For both `update` commands, the `--tags` argument accepts either inline JSON or a path to a JSON file.
102
112
103
113
For example:
@@ -122,7 +132,7 @@ az iot hub module-twin update \
122
132
123
133
:::image type="content" source="media/create-update-group/ungrouped-devices.png" alt-text="Screenshot of ungrouped devices." lightbox="media/create-update-group/ungrouped-devices.png":::
124
134
125
-
Once you create a group, the compliance chart and group list update. The Device Update compliance chart shows the count of devices in various states of compliance: **On latest update**, **New updates available**, and **Updates in progress**. For more information, see [Device Update compliance.](device-update-compliance.md).
135
+
Once you create a group, the compliance chart and group list update. The Device Update compliance chart shows the count of devices in various states of compliance: **On latest update**, **New updates available**, and **Updates in progress**. For more information, see [Device Update compliance](device-update-compliance.md).
126
136
127
137
Existing Device Update groups and any available updates for the devices in those groups appear in the group list. Any devices that don't meet the device class requirements of the group appear in a corresponding invalid group. You can deploy the best available update to a group from this view by selecting **Deploy** next to the group.
128
138
@@ -190,12 +200,12 @@ This action deletes the group tag from the device twin and removes the device fr
190
200
191
201
## Delete a device group
192
202
193
-
Device Update automatically creates device groups, but it retains device groups, device classes, and deployments for historical records or other user needs, and doesn't automatically clean them up. You can delete device groups through the Azure portal by individually selecting and deleting the groups, or by calling the [`az iot du device group delete`](/cli/azure/iot/du/device/group#az-iot-du-device-group-delete)API on the group.
203
+
Device Update automatically creates device groups, and it retains device groups, device classes, and deployments for historical records or other user needs, rather than automatically cleaning them up. You can delete device groups through the Azure portal by individually selecting and deleting the groups, or by calling the [`az iot du device group delete`](/cli/azure/iot/du/device/group#az-iot-du-device-group-delete)Azure CLI command on the group.
194
204
195
205
To be deleted, a group must meet the following requirements:
196
206
197
207
- Must not be a `default` group.
198
-
- Must have no member devices. That is, no device provisioned in the Device Update instance can have a`ADUGroup` tag with a value matching the group's name.
208
+
- Must have no member devices. That is, no device provisioned in the Device Update instance can have an`ADUGroup` tag with a value matching the group's name.
199
209
- Must have no associated active or canceled deployments.
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/deploy-update.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Deploy an update by using Azure Device Update for IoT Hub | Microsoft Doc
3
3
description: Learn how to deploy an update to IoT devices by using Azure Device Update for IoT Hub in the Azure portal or with Azure CLI.
4
4
author: vimeht
5
5
ms.author: vimeht
6
-
ms.date: 01/10/2025
6
+
ms.date: 01/23/2025
7
7
ms.topic: how-to
8
8
ms.service: azure-iot-hub
9
9
ms.custom: devx-track-azurecli
@@ -32,9 +32,9 @@ This section describes how to deploy the update by using the Azure portal or Azu
32
32
33
33
:::image type="content" source="media/deploy-update/device-update-iot-hub.png" alt-text="Screenshot that shows the Get started with the Device Update for IoT Hub page." lightbox="media/deploy-update/device-update-iot-hub.png":::
34
34
35
-
1. On the **Updates** page, select the **Groups and Deployments** tab and view the [update compliance chart](device-update-compliance.md) and [device group list](device-update-groups.md). You might need to refresh the view to see the new imported update available for your device group.
35
+
1. On the **Updates** page, select the **Groups and Deployments** tab and view the [update compliance chart](device-update-compliance.md) and [device group list](device-update-groups.md). You might need to refresh the view to see recently imported updates available for your device group.
36
36
37
-
Under **Status** in the group list, select **Deploy** next to **One or more new updates are available for this group**.
37
+
1. Under **Status** in the group list, select **Deploy** next to **One or more new updates are available for this group**.
38
38
39
39
:::image type="content" source="media/deploy-update/updated-view.png" alt-text="Screenshot that shows the Groups and Deployments tab." lightbox="media/deploy-update/updated-view.png":::
40
40
@@ -188,7 +188,7 @@ az iot du device deployment create \
188
188
189
189
:::image type="content" source="media/deploy-update/deployment-details.png" alt-text="Screenshot that shows deployment details." lightbox="media/deploy-update/deployment-details.png":::
190
190
191
-
Go to the **Group basics** tab of the **Group details** page to search the status for a particular device, or filter to view devices that failed the deployment.
191
+
Go to the **Group basics** tab of the **Group details** page to search for the status of a particular device, or filter to view devices that failed the deployment.
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/device-update-groups.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Azure Device Update for IoT Hub device groups
3
3
description: Understand Azure Device Update for IoT Hub user-assigned and default device groups and subgroups based on device classes.
4
4
author: aysancag
5
5
ms.author: aysancag
6
-
ms.date: 01/10/2025
6
+
ms.date: 01/23/2025
7
7
ms.topic: concept-article
8
8
ms.service: azure-iot-hub
9
9
ms.subservice: device-update
@@ -27,7 +27,7 @@ You define device groups by using *tags*. Device Update creates user-defined gro
27
27
28
28
## Default device groups
29
29
30
-
Devices that have the Device Update agent installed and provisioned but don't have an `ADUGroup` tag in their device or module twins are automatically added to a `default` group based on their device class. Devices with the same device class are grouped together in the default group, also called a *system-assigned group*.
30
+
Devices that have the Device Update agent installed and provisioned but don't have an `ADUGroup` tag in their device or module twins are automatically added to a `default` group based on their device class. Devices with the same device class are grouped together in a default group, also called a *system-assigned group*.
31
31
32
32
Users can't delete or recreate default groups, change their definitions, or add or remove devices from default groups manually. Default group names have the format `Default-<deviceClassID>`, and are reserved within an IoT solution.
0 commit comments