Skip to content

Commit 4ab23b3

Browse files
committed
further edits
1 parent c9695ea commit 4ab23b3

File tree

4 files changed

+36
-36
lines changed

4 files changed

+36
-36
lines changed

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,18 @@ ms.subservice: device-update
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 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.
1515

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.
1717

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).
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).
2323
- 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.
2424
- An [imported update for the provisioned device](import-update.md).
2525

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-
3626
## Add tags to your devices
3727

3828
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
5141
}
5242
```
5343

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+
5452
The following sections describe several ways to add and update the tag.
5553

5654
### Add tags with SDKs
@@ -62,10 +60,10 @@ You can update the device or module twin with the appropriate tag using Registry
6260

6361
### Add tags using jobs
6462

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).
6664

6765
> [!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).
6967
7068
### Add tags by updating twins
7169

@@ -174,6 +172,8 @@ az iot du device group show \
174172
--account <Device Update account name> \
175173
--instance <Device Update instance name> \
176174
--group-id <value of the ADUGroup tag for this group>
175+
--best-updates
176+
--update-compliance
177177
```
178178

179179
---

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ 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 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.
1616

1717
## Prerequisites
1818

@@ -32,11 +32,11 @@ This section describes how to deploy the update by using the Azure portal or Azu
3232

3333
:::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":::
3434

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.
3636

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**.
3838

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":::
4040

4141
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.
4242

@@ -78,30 +78,30 @@ Or, if you prefer, you can run the Azure CLI commands locally:
7878
7979
### Verify update availability
8080

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.
8282

8383
```azurecli
8484
az iot du device group list \
8585
--account <Device Update account name> \
8686
--instance <Device Update instance name>\
8787
```
8888

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:
9090

9191
- `--account`: The Device Update account name.
9292
- `--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.
9797

98-
Run the command as follows:
98+
To verify the best available update for your group, run the command as follows:
9999

100100
```azurecli
101101
az iot du device group show \
102102
--account <Device Update account name> \
103103
--instance <Device Update instance name>\
104-
--gid <device group id>\
104+
--group-id <device group ID>\
105105
--best-updates
106106
```
107107

@@ -111,7 +111,7 @@ Use [`az iot du device deployment create`](/cli/azure/iot/du/device/deployment#a
111111

112112
- `--account`: The Device Update account name.
113113
- `--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.
115115
- `--deployment-id`: An ID to identify this deployment.
116116
- `--update-name`, `--update-provider`, and `--update-version`: The parameters that define the `updateId` object, a unique identifier for the update in this deployment.
117117

@@ -121,8 +121,8 @@ Run the command as follows:
121121
az iot du device deployment create \
122122
--account <Device Update account name> \
123123
--instance <Device Update instance name> \
124-
--group-id <device group id> \
125-
--deployment-id <deployment id> \
124+
--group-id <device group ID> \
125+
--deployment-id <deployment ID> \
126126
--update-name <update name> \
127127
--update-provider <update provider> \
128128
--update-version <update version>
@@ -144,8 +144,8 @@ Run the command as follows:
144144
az iot du device deployment create \
145145
--account <Device Update account name> \
146146
--instance <Device Update instance name> \
147-
--group-id <device group id> \
148-
--deployment-id <deployment id> \
147+
--group-id <device group ID> \
148+
--deployment-id <deployment ID> \
149149
--update-name <update name> \
150150
--update-provider <update provider> \
151151
--update-version <update version> \

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ ms.subservice: device-update
1111

1212
# Azure Device Update for IoT Hub device groups
1313

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

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.
1717

1818
## User-defined device groups
1919

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.
2121

2222
```json
2323
"tags": {
@@ -31,7 +31,7 @@ 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-
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.
3535

3636
## Example device group assignments
3737

-81.8 KB
Loading

0 commit comments

Comments
 (0)