Skip to content

Commit f28e377

Browse files
authored
Merge pull request #188554 from paulth1/five-iot-hub-device-update-articles
edit pass: Five iot hub device update articles
2 parents 82c2978 + 556032c commit f28e377

7 files changed

+490
-493
lines changed

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

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,89 @@
11
---
2-
title: Deploy an update using Device Update for Azure IoT Hub | Microsoft Docs
3-
description: Deploy an update using Device Update for Azure IoT Hub.
2+
title: Deploy an update by using Device Update for Azure IoT Hub | Microsoft Docs
3+
description: Deploy an update by using Device Update for Azure IoT Hub.
44
author: vimeht
55
ms.author: vimeht
66
ms.date: 2/11/2021
77
ms.topic: how-to
88
ms.service: iot-hub-device-update
99
---
1010

11-
# Deploy an Update using Device Update for IoT Hub
11+
# Deploy an update by using Device Update for Azure IoT Hub
1212

13-
Learn how to deploy an update to an IoT device using Device Update for IoT Hub.
13+
Learn how to deploy an update to an IoT device by using Device Update for Azure IoT Hub.
1414

1515
## Prerequisites
1616

17-
* [Access to an IoT Hub with Device Update for IoT Hub enabled](create-device-update-account.md). It is recommended that you use a S1 (Standard) tier or above for your IoT Hub.
18-
* [At least one update has been successfully imported for the provisioned device.](import-update.md)
17+
* [Access to an IoT hub with Device Update for IoT Hub enabled](create-device-update-account.md). We recommend that you use an S1 (Standard) tier or above for your IoT Hub instance.
18+
* [At least one update has been successfully imported for the provisioned device](import-update.md).
1919
* An IoT device (or simulator) provisioned for Device Update within IoT Hub.
20-
* [The device is part of at least one default group or user-created update group.](create-update-group.md)
20+
* [The device is part of at least one default group or user-created update group](create-update-group.md).
2121
* Supported browsers:
2222
* [Microsoft Edge](https://www.microsoft.com/edge)
2323
* Google Chrome
2424

25-
## Deploy an update
25+
## Deploy the update
2626

27-
1. Go to [Azure portal](https://portal.azure.com)
27+
1. Go to the [Azure portal](https://portal.azure.com).
2828

29-
2. Navigate to the Device Update blade of your IoT Hub.
29+
1. Go to the **Device Update** pane of your IoT Hub instance.
3030

31-
:::image type="content" source="media/deploy-update/device-update-iot-hub.png" alt-text="IoT Hub" lightbox="media/deploy-update/device-update-iot-hub.png":::
31+
:::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":::
3232

33-
3. Select the Groups and Deployments tab at the top of the page. [Learn More](device-update-groups.md) about device groups.
33+
1. Select the **Groups and Deployments** tab at the top of the page. [Learn more](device-update-groups.md) about device groups.
3434

35-
:::image type="content" source="media/deploy-update/updated-view.png" alt-text="Groups and Deployments tab" lightbox="media/deploy-update/updated-view.png":::
35+
:::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":::
3636

37-
4. View the update compliance chart and groups list. You should see a new update available for your device group listed under Best Update (you may need to Refresh once). [Learn More about update compliance.](device-update-compliance.md)
37+
1. View the update compliance chart and groups list. You should see a new update available for your device group listed under **Best update**. You might need to refresh once. [Learn more about update compliance](device-update-compliance.md).
3838

39-
5. Select the target group by clicking on the group name. You will be directed to the group details under Group basics.
39+
1. Select the target group by selecting the group name. You're directed to the group details under **Group basics**.
4040

41-
:::image type="content" source="media/deploy-update/group-basics.png" alt-text="Group details" lightbox="media/deploy-update/group-basics.png":::
41+
:::image type="content" source="media/deploy-update/group-basics.png" alt-text="Screenshot that shows the Group details." lightbox="media/deploy-update/group-basics.png":::
4242

43-
6. To initiate the deployment, go to the Current deployment tab. Click the deploy link next to the desired update from the Available updates section. The best, available update for a given group will be denoted with a "Best" highlight.
43+
1. To start the deployment, go to the **Current deployment** tab. Select the deploy link next to the desired update from the **Available updates** section. The best available update for a given group is denoted with a **Best** highlight.
4444

45-
:::image type="content" source="media/deploy-update/select-update.png" alt-text="Select update" lightbox="media/deploy-update/select-update.png":::
45+
:::image type="content" source="media/deploy-update/select-update.png" alt-text="Screenshot that shows Best highlighted." lightbox="media/deploy-update/select-update.png":::
46+
47+
1. Schedule your deployment to start immediately or in the future. Then select **Create**.
4648

47-
7. Schedule your deployment to start immediately or in the future, then select Create.
4849
> [!TIP]
49-
> By default the Start date/time is 24 hrs from your current time. Be sure to select a different date/time if you want the deployment to begin earlier.
50-
:::image type="content" source="media/deploy-update/create-deployment.png" alt-text="Create deployment" lightbox="media/deploy-update/create-deployment.png":::
50+
> By default, the **Start** date and time is 24 hours from your current time. Be sure to select a different date and time if you want the deployment to begin earlier.
5151
52-
8. The Status under Deployment details should turn to Active, and the deployed update should be marked with "(deploying)".
52+
:::image type="content" source="media/deploy-update/create-deployment.png" alt-text="Screenshot that shows the Create deployment screen" lightbox="media/deploy-update/create-deployment.png":::
5353

54-
:::image type="content" source="media/deploy-update/deployment-active.png" alt-text="Deployment active" lightbox="media/deploy-update/deployment-active.png":::
54+
1. Under **Deployment details**, **Status** turns to **Active**. The deployed update is marked with **(deploying)**.
5555

56-
9. View the compliance chart. You should see the update is now in progress.
56+
:::image type="content" source="media/deploy-update/deployment-active.png" alt-text="Screenshot that shows deployment as Active." lightbox="media/deploy-update/deployment-active.png":::
5757

58-
:::image type="content" source="media/deploy-update/update-in-progress.png" alt-text="Update in progress" lightbox="media/deploy-update/update-in-progress.png":::
58+
1. View the compliance chart to see that the update is now in progress.
5959

60-
10. After your device is successfully updated, you should see your compliance chart and deployment details update to reflect the same.
60+
:::image type="content" source="media/deploy-update/update-in-progress.png" alt-text="Screenshot that shows Updates in progress." lightbox="media/deploy-update/update-in-progress.png":::
6161

62-
:::image type="content" source="media/deploy-update/update-succeeded.png" alt-text="Update succeeded" lightbox="media/deploy-update/update-succeeded.png":::
62+
1. After your device is successfully updated, you see that your compliance chart and deployment details updated to reflect the same.
6363

64-
## Monitor an update deployment
64+
:::image type="content" source="media/deploy-update/update-succeeded.png" alt-text="Screenshot that shows the update succeeded." lightbox="media/deploy-update/update-succeeded.png":::
6565

66-
1. Select the Deployment history tab at the top of the page.
66+
## Monitor the update deployment
6767

68-
:::image type="content" source="media/deploy-update/deployments-history.png" alt-text="Deployment History" lightbox="media/deploy-update/deployments-history.png":::
68+
1. Select the **Deployment history** tab at the top of the page.
6969

70-
2. Select the details link next to the deployment you created.
70+
:::image type="content" source="media/deploy-update/deployments-history.png" alt-text="Screenshot that shows the Deployment history tab." lightbox="media/deploy-update/deployments-history.png":::
7171

72-
:::image type="content" source="media/deploy-update/deployment-details.png" alt-text="Deployment details" lightbox="media/deploy-update/deployment-details.png":::
72+
1. Select **Details** next to the deployment you created.
7373

74-
3. Select Refresh to view the latest status details.
74+
:::image type="content" source="media/deploy-update/deployment-details.png" alt-text="Screenshot that shows deployment details." lightbox="media/deploy-update/deployment-details.png":::
7575

76+
1. Select **Refresh** to view the latest status details.
7677

7778
## Retry an update deployment
7879

79-
If your deployment fails for some reason, you can retry the deployment for failed devices.
80+
If your deployment fails for some reason, you can retry the deployment for failed devices.
8081

81-
1. Go to the Current deployment tab from the group details.
82+
1. Go to the **Current deployment** tab on the **Group details** screen.
8283

83-
:::image type="content" source="media/deploy-update/deployment-active.png" alt-text="Deployment active" lightbox="media/deploy-update/deployment-active.png":::
84+
:::image type="content" source="media/deploy-update/deployment-active.png" alt-text="Screenshot that shows the deployment as Active." lightbox="media/deploy-update/deployment-active.png":::
8485

85-
2. Click on "Retry failed devices" and acknowledge the confirmation notification.
86+
1. Select **Retry failed devices** and acknowledge the confirmation notification.
8687

8788
## Next steps
8889

articles/iot-hub-device-update/device-update-agent-provisioning.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Follow these instructions to provision the Device Update agent on [IoT Edge enab
9191

9292
1. Install the Device Update image update agent.
9393

94-
We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-sd-card-with-image).
94+
We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
9595

9696
1. Install the Device Update package update agent.
9797

@@ -121,7 +121,7 @@ Follow these instructions to provision the Device Update agent on your IoT Linux
121121

122122
2. Configure the IoT Identity Service by following the instructions in [Configuring the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/configuration.html).
123123

124-
3. Finally install the Device Update agent. We provide sample images in [Assets here](https://github.com/Azure/iot-hub-device-update/releases), the swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board, and the .gz file is the update you would import through Device Update for IoT Hub. See example of [how to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-sd-card-with-image).
124+
3. Finally install the Device Update agent. We provide sample images in [Assets here](https://github.com/Azure/iot-hub-device-update/releases), the swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board, and the .gz file is the update you would import through Device Update for IoT Hub. See example of [how to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
125125

126126
4. After you've installed the device update agent, you will need to edit the configuration file for Device Update by running the command below.
127127
@@ -136,7 +136,7 @@ Follow these instructions to provision the Device Update agent on your IoT Linux
136136
137137
The Device Update agent can also be configured without the IoT Identity service for testing or on constrained devices. Follow the below steps to provision the Device Update agent using a connection string (from the Module or Device).
138138
139-
1. We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-sd-card-with-image).
139+
1. We provide sample images in the [Assets here](https://github.com/Azure/iot-hub-device-update/releases) repository. The swUpdate file is the base image that you can flash onto a Raspberry Pi B3+ board. The .gz file is the update you would import through Device Update for IoT Hub. For an example, see [How to flash the image to your IoT Hub device](./device-update-raspberry-pi.md#flash-an-sd-card-with-the-image).
140140
141141
1. Log onto the machine or IoT Edge device/IoT device.
142142

0 commit comments

Comments
 (0)