|
1 | 1 | ---
|
2 |
| -title: Understand Device Update for Azure IoT Hub device groups |
3 |
| -description: Understand how device groups are used. |
| 2 | +title: Azure Device Update for IoT Hub device groups |
| 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: 2/09/2021 |
| 6 | +ms.date: 01/07/2025 |
7 | 7 | ms.topic: concept-article
|
8 | 8 | ms.service: azure-iot-hub
|
9 | 9 | ms.subservice: device-update
|
10 | 10 | ---
|
11 | 11 |
|
12 |
| -# Device groups |
| 12 | +# Azure Device Update for IoT Hub device groups |
13 | 13 |
|
14 |
| -A device group is a collection of devices. Device groups provide a way to scale deployments to many devices. Each device belongs to exactly one device group at a time. |
| 14 | +An Azure Device Update for IoT Hub device group is a collection of IoT devices that provides a way to target deployments. Any device that has the Device Update agent installed and provisioned belongs to a device group. |
15 | 15 |
|
16 |
| -You may choose to create multiple device groups to organize your devices. For example, Contoso might use the "Flighting" device group for the devices in its test laboratory and the "Evaluation" device group for the devices that its field team uses in the operations center. Further, Contoso might choose to group their production devices based on their geographic regions, so that they can update devices on a schedule that aligns with their regional timezones. |
| 16 | +You can use the default device group that Device Update assigns, or you can create and assign multiple device groups to organize your devices. For example, the Contoso organization might use a "Flighting" device group for the devices in its test laboratory and the "Evaluation" device group for the devices its field team uses in the operations center. 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. |
17 | 17 |
|
18 |
| -## Create device groups using device or module twin tags |
| 18 | +## User-defined device groups |
19 | 19 |
|
20 |
| -Tags enable users to group devices. Devices need to have a ADUGroup key and a value in their device or module twin to allow them to be grouped. |
21 |
| - |
22 |
| -### Device or module twin tag format |
| 20 | +You use *tags* to group devices. An `ADUGroup` key with a user-defined value in the `"tags"` section of the device twin or module twin specifies a user-defined device group. |
23 | 21 |
|
24 | 22 | ```json
|
25 | 23 | "tags": {
|
26 | 24 | "ADUGroup": "<CustomTagValue>"
|
27 | 25 | }
|
28 | 26 | ```
|
29 | 27 |
|
30 |
| -## Default device group |
| 28 | +## Default device groups |
| 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 groups, also called *system-assigned groups*. |
| 31 | + |
| 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. |
| 33 | + |
| 34 | +The default groups help reduce the overhead of tagging and grouping devices, to 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. |
31 | 35 |
|
32 |
| -Any device that has the Device Update agent installed and provisioned, but doesn't have the ADUGroup tag added to its device or module twin, will be added to a default group. Default groups, also called system-assigned groups, help reduce the overhead of tagging and grouping devices, so customers can easily deploy updates to them. Default groups can't be deleted or re-created by customers. Customers can't change the definition or add/remove devices from a default group manually. Devices with the same device class are grouped together in a default group. Default group names are reserved within an IOT solution. Default groups will be named in the format `Default-<deviceClassID>`. All deployment features that are available for user-defined groups are also available for default, system-assigned groups. |
| 36 | +## Example device group assignments |
33 | 37 |
|
34 |
| -For example consider the devices with their device twin tags below: |
| 38 | +For the Contoso example, consider four devices with the following device twins: |
35 | 39 |
|
36 | 40 | ```json
|
37 | 41 | "deviceId": "Device1",
|
38 | 42 | "tags": {
|
39 |
| - "ADUGroup": "Group1" |
| 43 | + "ADUGroup": "Flighting" |
40 | 44 | }
|
41 | 45 | ```
|
42 | 46 |
|
43 | 47 | ```json
|
44 | 48 | "deviceId": "Device2",
|
45 | 49 | "tags": {
|
46 |
| - "ADUGroup": "Group1" |
| 50 | + "ADUGroup": "Flighting" |
47 | 51 | }
|
48 | 52 | ```
|
49 | 53 |
|
50 | 54 | ```json
|
51 | 55 | "deviceId": "Device3",
|
52 | 56 | "tags": {
|
53 |
| - "ADUGroup": "Group2" |
| 57 | + "ADUGroup": "Evaluation" |
54 | 58 | }
|
55 | 59 | ```
|
56 | 60 |
|
57 | 61 | ```json
|
58 | 62 | "deviceId": "Device4",
|
59 | 63 | ```
|
60 | 64 |
|
61 |
| -Below are the devices and the possible groups that can be created for them. |
62 |
| - |
63 |
| -| Device | Group | |
64 |
| -|---------|-------------------------------| |
65 |
| -| Device1 | Group1 | |
66 |
| -| Device2 | Group1 | |
67 |
| -| Device3 | Group2 | |
68 |
| -| Device4 | DefaultGroup | |
69 |
| - |
| 65 | +Device1 and Device2 are both assigned to the "Flighting" device group. Device3 is assigned to the "Evaluation" device group. Device4 has no tags so is assigned to the default device group. |
70 | 66 |
|
71 | 67 | ## Subgroups
|
72 | 68 |
|
73 |
| -All user-created groups as well as default groups are automatically sub-categorized into one or more subgroups to allow administrators to manage heterogeneous devices in an organized and efficient manner, by providing a way to perform updates on a set of devices that share compatibility properties. Each device class within a group maps to one subgroup. Devices are added to a subgroup based on their compatibility properties and the Device Update PnP model ID, which together comprise a device class. |
74 |
| - |
75 |
| -A group can have one or more best available update, one for each subgroup it contains. |
| 69 | +Device Update automatically categorizes all user-created and default groups into one or more subgroups. Subgroups help administrators manage heterogeneous devices in an organized and efficient manner by updating sets of devices that share compatibility properties. |
76 | 70 |
|
77 |
| -[Learn more](./device-update-configuration-file.md) about setting compatibility properties on the Device Update agent |
| 71 | +Device Update adds devices to subgroups based on their compatibility properties and the Device Update PnP model ID, which together comprise a device class. Each device class within a group maps to one subgroup. A group can have one or more best available updates, one for each of its subgroups. |
78 | 72 |
|
79 |
| -## Next steps |
| 73 | +## Related content |
80 | 74 |
|
81 |
| -[Create a device group](./create-update-group.md) |
| 75 | +- To learn how to create, view, and delete device group tags and assign and remove devices from groups, see [Manage device groups](create-update-group.md). |
| 76 | +- For more information about about setting compatibility properties on the Device Update agent, see [Device Update configuration file](device-update-configuration-file.md). |
0 commit comments