Skip to content

Commit b743cad

Browse files
committed
touchups
1 parent 0bd7f89 commit b743cad

File tree

4 files changed

+17
-14
lines changed

4 files changed

+17
-14
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ The `files` section of the import manifest contains update payload file metadata
190190
191191
## Create an import manifest
192192

193-
Once you understand the structure of an import manifest, create an import manifest to describe your update. You can author a JSON import manifest manually using a text editor, but the Azure CLI [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command simplifies the process. For more information and instructions, see [Prepare an update to import into Device Update](create-update.md).
193+
Once you understand the structure of an import manifest, create an import manifest file to describe your update. You can author a JSON import manifest file manually using a text editor, but the Azure CLI [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command simplifies the process. For more information and instructions, see [Prepare an update to import into Device Update](create-update.md).
194194

195195
> [!IMPORTANT]
196196
> To import into the Azure portal, an import manifest JSON filename must end with *.importmanifest.json*.
@@ -204,6 +204,7 @@ Certain limits are enforced for Device Update instances, including import limits
204204

205205
## Related content
206206

207-
- [Import manifest schema](import-schema.md).
208-
- [Prepare an update to import](create-update.md).
207+
- [Import manifest schema](import-schema.md)
208+
- [Device Update update manifest](update-manifest.md)
209+
- [Prepare an update to import](create-update.md)
209210
- [Import an update](import-update.md)

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

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

1414
When you import an update into Azure Device Update for Iot Hub, you also submit an associated JSON import manifest file that defines important information about the update. This article describes the schema used to create the JSON import manifest file.
1515

16-
To learn more about import manifest concepts and file structure, see [Azure Device Update for IoT Hub import manifest concepts](import-concepts.md). To learn how to create the file, see [Prepare an update to import into Device Update for IoT Hub](import-update.md).
16+
To learn more about import manifest concepts and file structure, see [Azure Device Update for IoT Hub import manifest](import-concepts.md). To learn how to create the file, see [Prepare an update to import into Device Update for IoT Hub](import-update.md).
1717

1818
## Schema
1919

@@ -29,16 +29,16 @@ The import manifest JSON schema is hosted at [SchemaStore.org](https://json.sche
2929
|**instructions**|`instructions`|Update installation instructions.|Yes|
3030
|**files**|`file` `[0-10]`|List of update payload files. Sum of all file sizes can't exceed 2 GB. Can be empty or null if all instruction steps are reference steps.|No|
3131
|**manifestVersion**|`string`|Import manifest schema version. Must be 5.0.|Yes|
32-
|**createdDateTime**|`string`|Date and time import manifest was created in ISO 8601 format, for example `"2020-10-02T22:18:04.9446744Z"`.|Yes|
32+
|**createdDateTime**|`string`|Import manifest creation date and time in ISO 8601 format, for example `"2020-10-02T22:18:04.9446744Z"`.|Yes|
3333

3434
### Update object
3535

3636
The `updateID` object is a unique identifier for each update.
3737

3838
|Property|Type|Description|Required|
3939
|---|---|---|---|
40-
|**provider**|`string`|Entity who is creating or directly responsible for the update. It can be a company name.<br>Pattern: `^[a-zA-Z0-9.-]+$`<br>Maximum length: 64 characters|Yes|
41-
|**name**|`string`|Identifier for a class of update. It can be a device class or model name.<br>Pattern: `^[a-zA-Z0-9.-]+$`<br>Maximum length: 64 characters|Yes|
40+
|**provider**|`string`|Entity who is creating or directly responsible for the update, such as a company name.<br>Pattern: `^[a-zA-Z0-9.-]+$`<br>Maximum length: 64 characters|Yes|
41+
|**name**|`string`|Identifier for a class of update, such as a device class or model name.<br>Pattern: `^[a-zA-Z0-9.-]+$`<br>Maximum length: 64 characters|Yes|
4242
|**version**|`string`|Two- to four-part dot-separated numerical version numbers. Each part must be a number between 0 and 2147483647, and leading zeroes are dropped.<br>Pattern: `^\d+(?:\.\d+)+$`<br>Examples: `"1.0"`, `"2021.11.8"`|Yes|
4343

4444
No other properties are allowed.
@@ -136,12 +136,12 @@ For example:
136136

137137
#### Reference step object
138138

139-
A `reference` step object is an installation instruction step that installs another update.
139+
A `reference` step object is an installation instruction step to install another update.
140140

141141
|Property|Type|Description|Required|
142142
|---|---|---|---|
143143
|**type**|`referenceStepType`|Instruction step type that installs another update. Must be `reference`.|Yes|
144-
|**description**|`stepDescription`|Optional instruction step description. Maximum length: 64 characters |No|
144+
|**description**|`stepDescription`|Optional instruction step description. Maximum length: 64 characters. |No|
145145
|**updateId**|`updateId`|Unique update identifier.|Yes|
146146

147147
No other properties are allowed.
@@ -249,7 +249,7 @@ The `downloadHandler` object specifies how to process any related files.
249249

250250
|Property|Type|Description|Required|
251251
|---|---|---|---|
252-
|**id**|`string`|Identifier for `downloadHandler`. Limit of 64 ASCII characters.|Yes|
252+
|**id**|`string`|Identifier for `downloadHandler`. Limit of 64 ASCII characters.|Yes, if using `relatedFiles`|
253253

254254
No other properties are allowed.
255255

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ To deploy an update to devices using Azure Device Update for IoT Hub, you first
1818
- A [Device Update account and instance configured with an IoT hub](create-device-update-account.md).
1919
- An IoT device or simulator [provisioned for Device Update](device-update-agent-provisioning.md) within the IoT hub.
2020
- Update files for your device, and an associated import manifest file created by following the instructions in [Prepare an update to import into Device Update](create-update.md).
21+
- An Azure Storage account and container to hold the imported files. Or, you can create a new storage account and container as part of the Azure portal based import process.
22+
23+
> [!IMPORTANT]
24+
> 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).
25+
2126
## Import an update
2227

2328
This section shows how to import an update using either the Azure portal or the Azure CLI. You can also [import an update by using the Device Update APIs](#import-using-the-device-update-apis) instead.
@@ -38,9 +43,6 @@ To import an update, you first upload the update and import manifest files into
3843

3944
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.
4045

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-
4446
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.
4547

4648
:::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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Device Update uses [IoT Plug and Play](device-update-plug-and-play.md) to send t
2121
The update manifest is different from the Device Update *import manifest*.
2222

2323
- The [import manifest](import-concepts.md) is a JSON file that describes the update to import into Device Update. Whoever creates the update for Device Update creates the corresponding import manifest file.
24-
- The update manifest is a JSON string object that communicates information to the Device Update agent during an update. The Device Update service automatically generates the update manifest by using some of the same properties defined in the import manifest.
24+
- The update manifest is a JSON string object that communicates information to the Device Update agent during an update. The Device Update service automatically generates the update manifest by including some of the same properties defined in the import manifest.
2525

2626
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).
2727

0 commit comments

Comments
 (0)