You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/device-update-plug-and-play.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Azure Device Update for IoT Hub and IoT Plug and Play
3
3
description: Understand how Azure Device Update for IoT Hub uses IoT Plug and Play interfaces to discover and manage devices that are over-the-air update capable.
4
4
author: eshashah-msft
5
5
ms.author: eshashah
6
-
ms.date: 01/10/2025
6
+
ms.date: 01/14/2025
7
7
ms.topic: concept-article
8
8
ms.service: azure-iot-hub
9
9
ms.subservice: device-update
@@ -39,7 +39,7 @@ The Device Update agent uses the following agent metadata fields to send informa
39
39
|resultDetails|string|device to cloud|A user-provided freeform string to provide more result details. Returned to the twin without parsing.|
40
40
|stepResults|map|device to cloud|The result reported by the agent, containing result code, extended result code, and result details for step updates. <br>Example: "step_1": { "resultCode": 0,"extendedResultCode": 0, "resultDetails": ""}|
41
41
|state|integer|device to cloud| An integer that indicates the current state of the Device Update agent. See [State](#state) for details. |
42
-
|workflow|complex|device to cloud| A set of values that indicate the deployment the agent is currently working on, the ID of the currently installed deployment, and acknowledgment of any retry request sent from service to agent. The `workflow` ID reports a `"nodeployment"` value once a deployment is cancelled. <br>Example: "workflow": {"action": 3,"ID": "11b6a7c3-6956-4b33-b5a9-87fdd79d2f01","retryTimestamp": "2022-01-26T11:33:29.9680598Z"}|
42
+
|workflow|complex|device to cloud| A set of values that indicate the deployment the agent is currently working on, the ID of the currently installed deployment, and acknowledgment of any retry request sent from service to agent. The `workflow` ID reports a `"nodeployment"` value once a deployment is canceled. <br>Example: "workflow": {"action": 3,"ID": "11b6a7c3-6956-4b33-b5a9-87fdd79d2f01","retryTimestamp": "2022-01-26T11:33:29.9680598Z"}|
43
43
|installedUpdateId|string|device to cloud|An ID of the currently installed Device Update deployment. This value captures the update ID JSON, or `null` for a device that never had an update through Device Update. <br>Example: "installedUpdateID" {"provider":"contoso","name":"image-update","version":"1.0.0"}"|
44
44
45
45
IoT Hub device twin example:
@@ -87,7 +87,7 @@ The **deviceProperties** field contains the manufacturer and model information f
87
87
|Name|Schema|Direction|Description|
88
88
|----|------|---------|-----------|
89
89
|manufacturer|string|device to cloud|The device manufacturer of the device, reported through `deviceProperties`.<br>The `DeviceUpdateCore` interface first attempts to read the `aduc_manufacturer` value from the [configuration file](device-update-configuration-file.md). If the value isn't populated in the configuration file, the interface defaults to reporting the compile-time definition for `ADUC_DEVICEPROPERTIES_MANUFACTURER`. This property is reported only at boot time. <br> Default value: 'Contoso'|
90
-
|model|string|device to cloud|The device model of the device, reported through `deviceProperties`. The `DeviceUpdateCore` interface first attempts to read the `aduc_model` value from the [configuration file](device-update-configuration-file.md). If the value isn't populated in the configuration file, the interface defaults to reporting the compile-time definition for `ADUC_DEVICEPROPERTIES_MODEL`. This property is reported only at boot time. <br> Default value: 'Video'|
90
+
|model|string|device to cloud|The device model of the device, reported through `deviceProperties`. The `DeviceUpdateCore` interface first attempts to read the `aduc_model` value from the [configuration file](device-update-configuration-file.md). If the value isn't populated in the configuration file, the interface defaults to reporting the compile-time definition for `ADUC_DEVICEPROPERTIES_MODEL`. This property is reported only at boot time. <br> Default value: 'Video'|
91
91
|contractModelId|string|device to cloud|Property the service uses to identify the base model version the Device Update agent is using to manage and communicate with the agent.<br>Value: `dtmi:azure:iot:deviceUpdateContractModel;3` for devices using Device Update agent version 1.1.0. <br>**Note:** Agents using `dtmi:azure:iot:deviceUpdateModel;2` must report the `contractModelId` as `dtmi:azure:iot:deviceUpdateContractModel;3`, because `deviceUpdateModel;3` is extended from `deviceUpdateContractModel;3`.|
92
92
|aduVer|string|device to cloud|Version of the Device Update agent running on the device. This value is read from the build only if `ENABLE_ADU_TELEMETRY_REPORTING` is set to `1` (true) during compile time. You can choose to opt out of version reporting by setting the value to `0` (false). For more information, see [How To Build the Device Update Agent](https://github.com/Azure/iot-hub-device-update/blob/main/docs/agent-reference/how-to-build-agent-code.md).|
93
93
|doVer|string|device to cloud|Version of the Delivery Optimization agent running on the device. The value is read from the build only if `ENABLE_ADU_TELEMETRY_REPORTING` is set to `1` (true) during compile time. You can choose to opt out of version reporting by setting the value to `0` (false).|
@@ -114,8 +114,8 @@ The **action** field represents the action the Device Update agent should take a
114
114
|applyDeployment|3|Apply the deployed update.|
115
115
|cancel|255|Stop processing the current action and go back to `Idle`, or tell an agent in the `Failed` state to go back to `Idle`.|
116
116
|download|0|Download published content or update and any other content needed. This action is sent only to devices with agent version 0.7.0 or older.|
117
-
|install|1|Install the content or update, typically to call the installer for the content or update. This action is sent only to devices with agent version 0.7.0 or older.|
118
-
|apply|2|Finalize the update by rebooting if necessary. This action is sent only to devices with agent version 0.7.0 or older.|
117
+
|install|1|Install the content or update, typically to call the installer for the content or update. Device Update sends this action only to devices with agent version 0.7.0 or older.|
118
+
|apply|2|Finalize the update by rebooting if necessary. Device Update sends this action only to devices with agent version 0.7.0 or older.|
Copy file name to clipboardExpand all lines: includes/device-update-for-iot-hub-limits.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ The following table shows the limits associated with various Device Update opera
30
30
| Number of device groups per instance | 100 | 10 | Yes |
31
31
| Number of device classes per instance | 80 | 10 | Yes |
32
32
| Number of active deployments per instance | 50, including one reserved for cancellations | 5, including one reserved for cancellations | Yes |
33
-
| Number of total deployments per instance, including all active, inactive, and cancelled deployments that aren't deleted | 100 | 20 | No |
33
+
| Number of total deployments per instance, including all active, inactive, and canceled deployments that aren't deleted | 100 | 20 | No |
34
34
| Number of update providers per instance | 25 | 2 | No |
35
35
| Number of update names per provider per instance | 25 | 2 | No |
36
36
| Number of update versions per update provider and name per instance | 100 | 5 | No |
@@ -41,4 +41,4 @@ The following table shows the limits associated with various Device Update opera
41
41
| Total data storage included per instance | 100 GB | 5 GB | No |
42
42
43
43
> [!NOTE]
44
-
> Cancelled or inactive deployments count toward your total deployment limit. Make sure to clean up these deployments periodically so you aren't prevented from creating new deployments.
44
+
> Canceled or inactive deployments count toward your total deployment limit. Make sure to clean up these deployments periodically so you aren't prevented from creating new deployments.
0 commit comments