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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,28 +11,18 @@ ms.subservice: device-update
11
11
12
12
# Manage device groups for Azure Device Update for IoT Hub
13
13
14
-
Azure Device Update for IoT Hub deploys updates to devices based on their assignment to a device group. You can deploy updates to your IoT devices by using the default group that Device Update creates, or optionally by defining groups of devices to deploy to.
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.
15
15
16
-
You can create and assign user-defined tag values to devices, and 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 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.
17
17
18
-
This article describes how to use the Azure portal or Azure CLI to manage user-defined Device Update groups and tags. To deploy updates to user-defined groups, or to deploy to the default group without specifying user-defined groups and tags, 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 groups and tags. To deploy updates to user-defined or default device groups, see [Deploy a device update](deploy-update.md).
19
19
20
20
## Prerequisites
21
21
22
22
- 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
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.
24
24
- An [imported update for the provisioned device](import-update.md).
25
25
26
-
## Tag properties and limitations
27
-
28
-
The `ADUGroup` tag that determines Device Update group assignment has the following properties and limitations:
29
-
30
-
- You can add any value to the tag except the reserved values `Uncategorized` and `$default`.
31
-
- 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.
32
-
- The tag value can't exceed 200 characters.
33
-
- The tag value can contain alphanumeric characters and the following special characters: `. - _ ~`.
34
-
- The `ADUGroup` tag name and group name values are case-sensitive.
35
-
36
26
## Add tags to your devices
37
27
38
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.
@@ -51,6 +41,14 @@ The Device Update `ADUGroup` tag uses a key-value format, as shown in the follow
51
41
}
52
42
```
53
43
44
+
The `ADUGroup` tag has the following properties and limitations:
45
+
46
+
- You can add any value to the tag except the reserved values `Uncategorized` and `$default`.
47
+
- 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
+
- The tag value can't exceed 200 characters.
49
+
- The tag value can contain alphanumeric characters and the following special characters: `. - _ ~`.
50
+
- The `ADUGroup` tag name and group name values are case-sensitive.
51
+
54
52
The following sections describe several ways to add and update the tag.
55
53
56
54
### Add tags with SDKs
@@ -62,10 +60,10 @@ You can update the device or module twin with the appropriate tag using Registry
62
60
63
61
### Add tags using jobs
64
62
65
-
You can schedule a job to add or update Device Update tags on multiple devices. For examples of job operations, see [Schedule jobs on multiple devices](../iot-hub/iot-hub-devguide-jobs.md). You can update either device twins or module twins using jobs, depending on whether the Device Update agent is provisioned with a device or module identity. For more information, see [Schedule and broadcast jobs](../iot-hub/iot-hub-csharp-csharp-schedule-jobs.md).
63
+
You can schedule jobs to add or update Device Update tags on multiple devices. For examples of job operations, see [Schedule jobs on multiple devices](../iot-hub/iot-hub-devguide-jobs.md). You can update either device twins or module twins using jobs, depending on whether the Device Update agent is provisioned with a device or module identity. For more information, see [Schedule and broadcast jobs](../iot-hub/iot-hub-csharp-csharp-schedule-jobs.md).
66
64
67
65
> [!NOTE]
68
-
> This job operation counts against your IoT Hub messages quota. If you change 50,000 or more device or module twin tags at a time, you might exceed your daily IoT Hub message quota and need to buy more IoT Hub units. For more information, see [Quotas and throttling](../iot-hub/iot-hub-devguide-quotas-throttling.md).
66
+
> This operation counts against your IoT Hub messages quota. If you change 50,000 or more device or module twin tags at a time, you might exceed your daily IoT Hub message quota and need to buy more IoT Hub units. For more information, see [Quotas and throttling](../iot-hub/iot-hub-devguide-quotas-throttling.md).
69
67
70
68
### Add tags by updating twins
71
69
@@ -174,6 +172,8 @@ az iot du device group show \
174
172
--account <Device Update account name> \
175
173
--instance <Device Update instance name> \
176
174
--group-id <value of the ADUGroup tag for this group>
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/deploy-update.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ms.subservice: device-update
12
12
13
13
# Deploy an update by using Azure Device Update for IoT Hub
14
14
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.
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.
16
16
17
17
## Prerequisites
18
18
@@ -32,11 +32,11 @@ 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).
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.
36
36
37
-
:::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":::
37
+
Under **Status** in the group list, select **Deploy** next to **One or more new updates are available for this group**.
38
38
39
-
1. You might need to refresh the view to see the new imported update available for your device group. Under **Status** in the group list, select **Deploy** next to **One or more new updates are available for this group**.
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
41
41
1. On the **Group details** page, confirm that the correct group and imported update appear. To start the deployment, on the **Current deployment** tab, select the **Deploy** link next to the desired update in the **Available updates** section. The best available update for a given group is denoted with a **Best** highlight.
42
42
@@ -78,30 +78,30 @@ Or, if you prefer, you can run the Azure CLI commands locally:
78
78
79
79
### Verify update availability
80
80
81
-
1. Use the [`az iot du device group list`](/cli/azure/iot/du/device/group#az-iot-du-device-group-list) command to find your device group information.
81
+
1. Use the [`az iot du device group list`](/cli/azure/iot/du/device/group#az-iot-du-device-group-list) command to identify your device group.
82
82
83
83
```azurecli
84
84
az iot du device group list \
85
85
--account <Device Update account name> \
86
86
--instance <Device Update instance name>\
87
87
```
88
88
89
-
1. Then use [`az iot du device group show`](/cli/azure/iot/du/device/group#az-iot-du-device-group-show) to verify the best available update for your group. The command takes the following arguments:
89
+
1. Then use [`az iot du device group show`](/cli/azure/iot/du/device/group#az-iot-du-device-group-show) to show the best available update for your group. The command takes the following arguments:
90
90
91
91
-`--account`: The Device Update account name.
92
92
-`--instance`: The Device Update instance name.
93
-
-`--resource-group`: Device Update account resource group name.
94
-
-`--group-id`: The device group ID that you're targeting with this deployment, either the value of the `ADUGroup` tag, or `$default` for devices with no tag.
95
-
-`--best-updates`: Fetches the best available updates for the device group, including a count of how many devices need each update.
96
-
-`--update-compliance`: Fetches device group update compliance information, such as how many devices are on their latest update, how many need new updates, and how many are currently receiving a new update.
93
+
-`--group-id`: The device group ID that you're targeting with this deployment, which is either the value of the `ADUGroup` tag, or `$default` for devices with no tag.
94
+
-`--resource-group`: The Device Update account resource group name.
95
+
-`--best-updates`: Returns the best available updates for the device group, including a count of how many devices need each update.
96
+
-`--update-compliance`: Returns device group update compliance information, such as how many devices are on their latest update, how many need new updates, and how many are currently receiving a new update.
97
97
98
-
Run the command as follows:
98
+
To verify the best available update for your group, run the command as follows:
99
99
100
100
```azurecli
101
101
az iot du device group show \
102
102
--account <Device Update account name> \
103
103
--instance <Device Update instance name>\
104
-
--gid <device group id>\
104
+
--group-id <device group ID>\
105
105
--best-updates
106
106
```
107
107
@@ -111,7 +111,7 @@ Use [`az iot du device deployment create`](/cli/azure/iot/du/device/deployment#a
111
111
112
112
-`--account`: The Device Update account name.
113
113
-`--instance`: The Device Update instance name.
114
-
-`--group-id`: The device group ID that you're targeting with this deployment, either the value of the `ADUGroup` tag, or `$default` for devices with no tag.
114
+
-`--group-id`: The device group ID that you're targeting with this deployment, which is either the value of the `ADUGroup` tag, or `$default` for devices with no tag.
115
115
-`--deployment-id`: An ID to identify this deployment.
116
116
-`--update-name`, `--update-provider`, and `--update-version`: The parameters that define the `updateId` object, a unique identifier for the update in this deployment.
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/device-update-groups.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
@@ -11,13 +11,13 @@ ms.subservice: device-update
11
11
12
12
# Azure Device Update for IoT Hub device groups
13
13
14
-
An Azure Device Update for IoT Hub device group is a collection of IoT devices that Device Update uses to target 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.
14
+
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.
15
15
16
-
To organize and deploy to your devices, you can use the default device group that Device Update assigns, or you can use multiple user-defined device groups. 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 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.
17
17
18
18
## User-defined device groups
19
19
20
-
You use *tags* to group devices. The `ADUGroup`key with a user-defined value in the `"tags"` section of the device twin or module twin specifies a user-defined device group for Device Update.
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.
21
21
22
22
```json
23
23
"tags": {
@@ -31,7 +31,7 @@ Devices that have the Device Update agent installed and provisioned but don't ha
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.
33
33
34
-
The 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 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.
0 commit comments