Skip to content

Commit 0000bde

Browse files
authored
Merge pull request #186953 from danewalton/dev-update
add link to import manifest
2 parents d7b0293 + afde5bf commit 0000bde

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ ms.service: iot-hub-device-update
1313

1414
## Overview
1515

16-
Device Update for IoT Hub uses an _update manifest_ to communicate actions and also metadata supporting those actions through the
16+
Device Update for IoT Hub uses an _update manifest_ to communicate actions and metadata that supports those actions through the
1717
[AzureDeviceUpdateCore.OrchestratorMetadata:4](./device-update-plug-and-play.md)interface properties.
1818
This document describes the fundamentals of how the `updateManifest` property, in the
1919
`AzureDeviceUpdateCore.OrchestratorMetadata:4` interface, is used by the Device Update Agent. The
2020
`AzureDeviceUpdateCore.OrchestratorMetadata:4` interface properties are sent from the Device Update for IoT Hub service
2121
to the Device Update Agent. The `updateManifest` is a serialized JSON Object that is parsed by the Device Update Agent.
2222

23+
The update manifest is auto generated after creation of an import manifest. For more information on how to generate an import manifest, [see here](./import-update.md).
24+
2325
### An example update manifest
2426

2527
```JSON
@@ -47,11 +49,11 @@ Device Update for IoT Hub uses an _update manifest_ to communicate actions and a
4749

4850
The purpose of the update manifest is to describe the contents of an update, namely its identity, type,
4951
installed criteria, and update file metadata. In addition, the update manifest is cryptographically signed to
50-
allow the Device Update Agent to verify its authenticity. Refer to the [Device Update security](./device-update-security.md) documentation for more information on how the update manifest is used to securely import content.
52+
allow the Device Update Agent to verify its authenticity. For more information, see the document on [Device Update security](./device-update-security.md).
5153

5254
## Import manifest vs update manifest
5355

54-
It is important to understand the differences between the import manifest and the update manifest concepts in Device Update for IoT Hub.
56+
It is important to understand the differences between the import manifest and the update manifest.
5557
* The [import manifest](./import-concepts.md) is created by whoever creates the corresponding update. It describes the contents of the update that will be imported into Device Update for IoT Hub.
5658
* The update manifest is automatically generated by the Device Update for IoT Hub service, using some of the properties that were defined in the import manifest. It is used to communicate relevant information to the Device Update Agent during the update process.
5759

@@ -70,7 +72,7 @@ to determine compatible devices for the update.
7072

7173
### updateType
7274

73-
Represents the type of update which is handled by a specific type of update handler. It follows the form
75+
Represents the type of update that is handled by a specific type of update handler. It follows the form
7476
of `microsoft/swupdate:1` for an image-based update and `microsoft/apt:1` for a package-based update (see `Update Handler Types` section below).
7577

7678
### installedCriteria
@@ -81,7 +83,7 @@ for each update type supported by Device Update for IoT Hub.
8183

8284
### files
8385

84-
Tells the Device Update Agent which files to download, and the hash that will be used to use to verify the files were downloaded correctly.
86+
Tells the Device Update Agent which files to download, and the hash that will be used to verify that the files downloaded correctly.
8587
Here's a closer look at the `files` property contents:
8688

8789
```json

0 commit comments

Comments
 (0)