|
1 | 1 | ---
|
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. |
4 | 4 | author: vimeht
|
5 | 5 | ms.author: vimeht
|
6 | 6 | ms.date: 2/11/2021
|
7 | 7 | ms.topic: how-to
|
8 | 8 | ms.service: iot-hub-device-update
|
9 | 9 | ---
|
10 | 10 |
|
11 |
| -# Deploy an Update using Device Update for IoT Hub |
| 11 | +# Deploy an update by using Device Update for Azure IoT Hub |
12 | 12 |
|
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. |
14 | 14 |
|
15 | 15 | ## Prerequisites
|
16 | 16 |
|
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). |
19 | 19 | * 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). |
21 | 21 | * Supported browsers:
|
22 | 22 | * [Microsoft Edge](https://www.microsoft.com/edge)
|
23 | 23 | * Google Chrome
|
24 | 24 |
|
25 |
| -## Deploy an update |
| 25 | +## Deploy the update |
26 | 26 |
|
27 |
| -1. Go to [Azure portal](https://portal.azure.com) |
| 27 | +1. Go to the [Azure portal](https://portal.azure.com). |
28 | 28 |
|
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. |
30 | 30 |
|
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"::: |
32 | 32 |
|
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. |
34 | 34 |
|
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"::: |
36 | 36 |
|
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). |
38 | 38 |
|
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**. |
40 | 40 |
|
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"::: |
42 | 42 |
|
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. |
44 | 44 |
|
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**. |
46 | 48 |
|
47 |
| -7. Schedule your deployment to start immediately or in the future, then select Create. |
48 | 49 | > [!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. |
51 | 51 |
|
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"::: |
53 | 53 |
|
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)**. |
55 | 55 |
|
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"::: |
57 | 57 |
|
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. |
59 | 59 |
|
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"::: |
61 | 61 |
|
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. |
63 | 63 |
|
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"::: |
65 | 65 |
|
66 |
| -1. Select the Deployment history tab at the top of the page. |
| 66 | +## Monitor the update deployment |
67 | 67 |
|
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. |
69 | 69 |
|
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"::: |
71 | 71 |
|
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. |
73 | 73 |
|
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"::: |
75 | 75 |
|
| 76 | +1. Select **Refresh** to view the latest status details. |
76 | 77 |
|
77 | 78 | ## Retry an update deployment
|
78 | 79 |
|
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. |
80 | 81 |
|
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. |
82 | 83 |
|
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"::: |
84 | 85 |
|
85 |
| -2. Click on "Retry failed devices" and acknowledge the confirmation notification. |
| 86 | +1. Select **Retry failed devices** and acknowledge the confirmation notification. |
86 | 87 |
|
87 | 88 | ## Next steps
|
88 | 89 |
|
|
0 commit comments