Skip to content

Commit 40bf10a

Browse files
committed
4th article
1 parent 70805ec commit 40bf10a

File tree

4 files changed

+25
-18
lines changed

4 files changed

+25
-18
lines changed

articles/iot-hub-device-update/import-concepts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Azure Device Update for IoT Hub import manifest
2+
title: Azure Device Update for IoT Hub import manifest concepts
33
description: Understand the important concepts and sections in the Azure Device Update for IoT Hub import manifest.
44
author: andrewbrownmsft
55
ms.author: andbrown
6-
ms.date: 12/31/2024
6+
ms.date: 01/02/2025
77
ms.topic: concept-article
88
ms.service: azure-iot-hub
99
ms.subservice: device-update
1010
---
1111

12-
# Azure Device Update for IoT Hub import manifest
12+
# Azure Device Update for IoT Hub import manifest concepts
1313

1414
To deploy an update to devices using Azure Device Update for IoT Hub, you first import the update into the Device Update service, which stores the imported update and deploys it to devices. Along with the update payload, you submit a JSON import manifest file that defines important information about the update. This article describes the important concepts and sections in the import manifest JSON file.
1515

articles/iot-hub-device-update/import-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Import manifest schema for Azure Device Update for IoT Hub
33
description: Understand the schema used to create the required import manifest for importing updates into Azure Device Update for IoT Hub.
44
author: andrewbrownmsft
55
ms.author: andbrown
6-
ms.date: 12/31/2024
6+
ms.date: 01/02/2025
77
ms.topic: concept-article
88
ms.service: azure-iot-hub
99
ms.subservice: device-update

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Import an update to Azure Device Update for IoT Hub
33
description: Learn how to import update files into Azure Device Update for IoT Hub by using the Azure portal, Azure CLI, or programmatically.
44
author: andrewbrownmsft
55
ms.author: andbrown
6-
ms.date: 12/31/2024
6+
ms.date: 01/02/2025
77
ms.topic: how-to
88
ms.service: azure-iot-hub
99
ms.subservice: device-update
@@ -38,6 +38,9 @@ To import an update, you first upload the update files and import manifest into
3838

3939
1. On the **Storage accounts** page, select an existing storage account or create a new account by selecting **Storage account**. You use the storage account for a container to stage the update files.
4040

41+
> [!IMPORTANT]
42+
> Make sure the storage account you use or create doesn't have private endpoints enabled. To see if private endpoints are enabled, you can check for your Azure Storage account name under **Private endpoints** in the [Private Link Center](https://portal.azure.com/#blade/Microsoft_Azure_Network/PrivateLinkCenterBlade/overview).
43+
4144
1. On the **Containers** page, select an existing container or create a new container by selecting **Container**. You use the container to stage the update files for import.
4245

4346
:::image type="content" source="media/import-update/storage-account-ppr.png" alt-text="Screenshot that shows Storage accounts and Containers.":::

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

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
---
2-
title: Device Update for IoT Hub update manifest
3-
description: Learn how properties are sent from the Device Update service to the device during an update
2+
title: Azure Device Update for IoT Hub update manifest
3+
description: Learn how the Azure Device Update for IoT Hub service uses the update manifest to send properties to devices during updates.
44
author: andrewbrownmsft
55
ms.author: andbrown
6-
ms.date: 08/19/2022
6+
ms.date: 01/02/2025
77
ms.topic: concept-article
88
ms.service: azure-iot-hub
99
ms.subservice: device-update
1010
---
1111

1212

13-
# Device Update for IoT Hub update manifest
13+
# Azure Device Update for IoT Hub update manifest
1414

15-
Device Update for IoT Hub uses [IoT Plug and Play](./device-update-plug-and-play.md) to send data to devices during deployment. One of them is the _update manifest_, a serialized JSON object string containing metadata of the update to install. It's also cryptographically signed to allow the Device Update agent to verify its authenticity. For more information on how the update manifest is used to securely install content, see [Device Update security](./device-update-security.md).
15+
This article describes how Azure Device Update for IoT Hub uses [IoT Plug and Play](./device-update-plug-and-play.md) to send *update manifest* data to devices during update deployment. The update manifest is a serialized JSON object string containing metadata about the update to install. The update manifest is cryptographically signed so the Device Update agent can verify its authenticity. For more information about how the update manifest is used to securely install content, see [Device Update security](./device-update-security.md).
1616

1717
## Import manifest vs update manifest
1818

19-
It's important to understand the differences between the import manifest and the update manifest concepts in Device Update for IoT Hub:
19+
The update manifest is different from the Device Update *import manifest*.
2020

21-
* The [import manifest](./import-concepts.md) is created by whomever creates the corresponding update. It describes the contents of the update that will be imported into Device Update for IoT Hub.
22-
* 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's used to communicate relevant information to the Device Update agent during the update process.
21+
- Whoever creates the update for Device Update also creates the corresponding [import manifest](./import-concepts.md), which describes the contents of the update to import into Device Update.
22+
- The Device Update service automatically generates the update manifest, using some of the same properties defined in the import manifest, to communicate information to the Device Update agent during the update process.
2323

24-
Each manifest type has its own schema and schema version.
24+
Each manifest type has its own schema and schema version. For more information about the import manifest schema, see [Device Update import manifest schema](import-schema.md).
2525

2626
## Update manifest schema
2727

28-
> [!IMPORTANT]
29-
> Update manifest JSON schema version 4 is hosted at [SchemaStore.org](https://json.schemastore.org/azure-deviceupdate-update-manifest-4.json).
28+
The update manifest JSON schema version 4 is hosted at [SchemaStore.org](https://json.schemastore.org/azure-deviceupdate-update-manifest-4.json).
3029

3130
### Example update manifest
3231

@@ -72,9 +71,9 @@ Each manifest type has its own schema and schema version.
7271

7372
### Full vs mini update manifest
7473

75-
When an update manifest exceeds a certain size that prevents it from being communicated efficiently, Device Update for IoT Hub will send it to the device in _detached_ format, also known as a _mini update manifest_. A mini manifest is technically metadata for update manifest and contains information needed for the Device Update agent to download the full update manifest and verify its authenticity.
74+
If an update manifest is too large to be communicated efficiently, Device Update sends it to the device in *detached* format, also known as a *mini update manifest*. A mini manifest contains metadata about the update manifest that Device Update agent needs to download the full update manifest and verify its authenticity.
7675

77-
Example mini update manifest:
76+
The following example shows a mini update manifest:
7877

7978
```json
8079
{
@@ -96,3 +95,8 @@ Example mini update manifest:
9695
}
9796
}
9897
```
98+
## Related content
99+
- [Device Update import manifest concepts](import-manifest.md)
100+
- [Device Update import manifest schema](import-schema.md)
101+
- [Prepare an update to import into Device Update](create-update.md)
102+
- [Import an update into Device Update](import-update.md)

0 commit comments

Comments
 (0)