Skip to content

Commit 8ebddb4

Browse files
committed
touchups
1 parent 4ab23b3 commit 8ebddb4

File tree

3 files changed

+33
-33
lines changed

3 files changed

+33
-33
lines changed

articles/iot-hub-device-update/create-update-group.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11
---
22
title: Manage device groups for Azure Device Update for IoT Hub | Microsoft Docs
3-
description: Learn how to configure Azure Device Update for IoT Hub device groups by using the ADUGroup tag in the Azure portal or with Azure CLI.
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.
44
author: vimeht
55
ms.author: vimeht
6-
ms.date: 01/09/2025
6+
ms.date: 01/10/2025
77
ms.topic: how-to
88
ms.service: azure-iot-hub
99
ms.subservice: device-update
1010
---
1111

1212
# Manage device groups for Azure Device Update for IoT Hub
1313

14-
Azure Device Update for IoT Hub deploys updates to devices based on their device group. You can use the default device group that Device Update provides, or you can define and assign your own device groups to deploy updates to.
14+
Azure Device Update for IoT Hub allows deploying updates to user-defined groups of IoT devices. Every Device Update managed device is a member of a device group, but defining device groups is optional. You can alternatively deploy to the default device group that Device Update provides.
1515

16-
If you create and assign user-defined tag values to devices, Device Update automatically creates groups based on the assigned tags and device compatibility properties. A device group can have multiple subgroups that have different device classes.
16+
If you create and assign user-defined Device Update tag values to devices, Device Update automatically creates groups based on the assigned tags and device compatibility properties. For each device group, Device Update can create multiple subgroups that have different device classes. Device Update places devices that have no tags in the `default` device group.
1717

18-
This article describes how to use the Azure portal or Azure CLI to create and manage user-defined Device Update groups and tags. To deploy updates to user-defined or default device groups, see [Deploy a device update](deploy-update.md).
18+
This article describes how to use the Azure portal or Azure CLI to create and manage user-defined Device Update device tags and groups. To deploy updates to user-defined or default device groups, see [Deploy a device update](deploy-update.md).
1919

2020
## Prerequisites
2121

2222
- 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-
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub. Install and start the Device Update agent on your device either as a module- or device-level identity.
23+
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub.
24+
- The Device Update agent installed and started on the device either as a module- or device-level identity.
2425
- An [imported update for the provisioned device](import-update.md).
2526

2627
## Add tags to your devices
2728

28-
To create a Device Update device group, you add an `ADUGroup` tag to the target set of devices in IoT Hub. The devices must be connected to Device Update.
29-
30-
Add the tag to the device twin if your Device Update agent is provisioned with device identity, or to the corresponding module twin if the Device Update agent is provisioned with a module identity. For more information and examples of twin JSON syntax, see [Understand and use device twins](../iot-hub/iot-hub-devguide-device-twins.md) or [Understand and use module twins](../iot-hub/iot-hub-devguide-module-twins.md).
29+
To assign a Device Update device group, you add the `ADUGroup` tag to a target set of Device Update connected devices in IoT Hub. Add the tag to the device twin if your Device Update agent is provisioned with device identity, or to the corresponding module twin if the Device Update agent is provisioned with a module identity.
3130

3231
The Device Update `ADUGroup` tag uses a key-value format, as shown in the following device or module twin example:
3332

@@ -41,10 +40,12 @@ The Device Update `ADUGroup` tag uses a key-value format, as shown in the follow
4140
}
4241
```
4342

44-
The `ADUGroup` tag has the following properties and limitations:
43+
For more information and examples of twin JSON syntax, see [Understand and use device twins](../iot-hub/iot-hub-devguide-device-twins.md) or [Understand and use module twins](../iot-hub/iot-hub-devguide-module-twins.md).
44+
45+
The `ADUGroup` tag has the following properties and limitations:
4546

46-
- You can add any value to the tag except the reserved values `Uncategorized` and `$default`.
4747
- A device can only have one `ADUGroup` tag and belong to only one Device Update group at a time. Adding another tag named `ADUGroup` overrides the existing `ADUGroup` value.
48+
- You can use any value for the tag except the reserved values `Uncategorized` and `$default`.
4849
- The tag value can't exceed 200 characters.
4950
- The tag value can contain alphanumeric characters and the following special characters: `. - _ ~`.
5051
- The `ADUGroup` tag name and group name values are case-sensitive.
@@ -97,9 +98,7 @@ You can use the Bash environment in [Azure Cloud Shell](/azure/cloud-shell/quick
9798
>1. Sign in to Azure by running [az login](/cli/azure/reference-index#az-login).
9899
>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`.
99100
100-
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.
101-
102-
For both `update` commands, the `--tags` argument accepts either inline JSON or a path to a JSON file.
101+
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.
103102

104103
For example:
105104

@@ -125,7 +124,7 @@ az iot hub module-twin update \
125124

126125
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).
127126

128-
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 the **Deploy** button next to the group.
127+
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.
129128

130129
:::image type="content" source="media/create-update-group/updated-view.png" alt-text="Screenshot of update compliance view." lightbox="media/create-update-group/updated-view.png":::
131130

@@ -199,16 +198,17 @@ To be deleted, a group must meet the following requirements:
199198
- 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.
200199
- Must have no associated active or canceled deployments.
201200

202-
> [!NOTE]
203-
> If you're unable to delete a group that meets the preceding requirements, check whether you have any *unhealthy* devices tagged as part of the group. Unhealthy devices can't receive a deployment, so they don't appear directly in the list of member devices in a group.
204-
>
205-
> To check whether you have any unhealthy devices:
206-
> 1. In the Azure portal, navigate to your IoT hub.
207-
> 1. Select **Updates** from the left navigation and then select the **Diagnostics** tab.
208-
> 1. Expand the **Find missing devices** section.
209-
> If you have unhealthy devices tagged as part of the group, you need to modify the tag value or delete the device before you can delete the group.
210-
211-
If a device is ever assigned to a deleted group name again, the group is automatically recreated, but there's no associated device or deployment history.
201+
>[!NOTE]
202+
>If you're unable to delete a group that meets the preceding requirements, check whether you have any *unhealthy* devices tagged as part of the group. Unhealthy devices can't receive a deployment, so they don't appear directly in the list of member devices in a group.
203+
>
204+
>To check whether you have any unhealthy devices:
205+
>1. In the Azure portal, navigate to your IoT hub.
206+
>1. Select **Updates** from the left navigation and then select the **Diagnostics** tab.
207+
>1. Expand the **Find missing devices** section.
208+
>
209+
> If you have unhealthy devices tagged as part of the group, you must change the tag value or delete the device before you can delete the group.
210+
211+
If a device is ever assigned to a deleted group name again, Device Update automatically recreates the group, but there's no associated device or deployment history.
212212

213213
## Related content
214214

articles/iot-hub-device-update/deploy-update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy an update by using Azure Device Update for IoT Hub | Microsoft Doc
33
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.
44
author: vimeht
55
ms.author: vimeht
6-
ms.date: 01/09/2025
6+
ms.date: 01/10/2025
77
ms.topic: how-to
88
ms.service: azure-iot-hub
99
ms.custom: devx-track-azurecli
@@ -12,12 +12,12 @@ ms.subservice: device-update
1212

1313
# Deploy an update by using Azure Device Update for IoT Hub
1414

15-
In this article, you learn how to use the Azure portal or Azure CLI to deploy an update to IoT devices by using Azure Device Update for IoT Hub.
15+
In this article, you 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.
1616

1717
## Prerequisites
1818

1919
- 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).
20-
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub. The provisioned device can be a member of a [user-created update group](create-update-group.md) or the default group.
20+
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub. The provisioned device can be a member of a [user-created device group](create-update-group.md) or the default group.
2121
- An [imported update for the provisioned device](import-update.md).
2222

2323
## Deploy the update

articles/iot-hub-device-update/device-update-groups.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Azure Device Update for IoT Hub device groups
33
description: Understand Azure Device Update for IoT Hub user-assigned and default device groups and subgroups based on device classes.
44
author: aysancag
55
ms.author: aysancag
6-
ms.date: 01/09/2025
6+
ms.date: 01/10/2025
77
ms.topic: concept-article
88
ms.service: azure-iot-hub
99
ms.subservice: device-update
@@ -13,11 +13,11 @@ ms.subservice: device-update
1313

1414
An Azure Device Update for IoT Hub device group is a collection of IoT devices that Device Update uses to target update deployments. All devices that have the Device Update agent installed and provisioned belong to a device group, either a default group or a user-defined group. A device can belong to only one Device Update device group at a time.
1515

16-
To deploy updates to your devices, you can use the default device group that Device Update provides, or you can define and assign multiple device groups to organize your devices. For example, the Contoso organization might assign the devices in its test laboratory to a "Flighting" device group and assign the devices its operations center field team uses to an "Evaluation" device group. Contoso might also choose to group their production devices based on geographic regions, so they can update devices on a schedule that aligns with their regional timezones.
16+
To deploy updates to your devices, you can use the default device group that Device Update provides, or you can define and assign multiple device groups to organize your devices. For example, the Contoso organization might assign the devices in its test laboratory to a "Flighting" device group and assign the devices its field team uses to an "Evaluation" device group. Contoso might also choose to group their production devices based on geographic regions, so they can update devices on a schedule that aligns with their regional timezones.
1717

1818
## User-defined device groups
1919

20-
You use *tags* to group devices. Device Update creates user-defined groups for devices that have an `ADUGroup` tag with a user-defined value in the `"tags"` section of their device twins or module twins.
20+
You define device groups by using *tags*. Device Update creates user-defined groups for devices that have an `ADUGroup` tag with a user-defined value in the `"tags"` section of their device twins or module twins.
2121

2222
```json
2323
"tags": {
@@ -31,11 +31,11 @@ Devices that have the Device Update agent installed and provisioned but don't ha
3131

3232
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.
3333

34-
Default groups help reduce the overhead of tagging and grouping devices and make it easier to deploy updates to untagged devices. All deployment features that are available for user-defined groups are also available for default, system-assigned groups.
34+
Default groups help reduce the overhead of tagging and grouping devices by making it easier to deploy updates to untagged devices. All deployment features that are available for user-defined groups are also available for default, system-assigned groups.
3535

3636
## Example device group assignments
3737

38-
For the Contoso example, consider four devices with the following device IDs and `ADUGroup` tag assignments:
38+
For the Contoso example, consider four devices with the following device IDs and tag assignments:
3939

4040
```json
4141
"deviceId": "Device1",

0 commit comments

Comments
 (0)