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
The IoT Edge agent and IoT Edge hub are two modules that make up the IoT Edge runtime. For more information about the responsibilities of each runtime module, see [Understand the Azure IoT Edge runtime and its architecture](iot-edge-runtime.md).
17
+
The IoT Edge agent and IoT Edge hub are two modules that make up the IoT Edge runtime. For more information about the responsibilities of each runtime module, see [understand the Azure IoT Edge runtime and its architecture](iot-edge-runtime.md).
18
18
19
-
This article provides the desired properties and reported properties of the runtime module twins. For more information on how to deploy modules on IoT Edge devices, see [Learn how to deploy modules and establish routes in IoT Edge](module-composition.md).
19
+
This article provides the desired properties and reported properties of the runtime module twins. For more information on how to deploy modules on IoT Edge devices, see [learn how to deploy modules and establish routes in IoT Edge](module-composition.md).
20
20
21
21
A module twin includes:
22
22
23
-
***Desired properties**. The solution backend can set desired properties, and the module can read them. The module can also receive notifications of changes in the desired properties. Desired properties are used along with reported properties to synchronize module configuration or conditions.
23
+
***Desired properties**. The solution backend sets desired properties, and the module reads them. The module also receives notifications of changes in the desired properties. Desired properties are used along with reported properties to synchronize module configuration or conditions.
24
24
25
-
***Reported properties**. The module can set reported properties, and the solution backend can read and query them. Reported properties are used along with desired properties to synchronize module configuration or conditions.
25
+
***Reported properties**. The module sets reported properties, and the solution backend reads and queries them. Reported properties are used along with desired properties to synchronize module configuration or conditions.
26
26
27
27
## EdgeAgent desired properties
28
28
29
-
The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates the communications between the IoT Edge agent running on a device and IoT Hub. The desired properties are set when applying a deployment manifest on a specific device as part of a single-device or at-scale deployment.
29
+
The module twin for the IoT Edge agent is called `$edgeAgent`. It coordinates communications between the IoT Edge agent running on a device and IoT Hub. The desired properties are set when applying a deployment manifest on a specific device as part of a single-device or at-scale deployment.
30
30
31
31
| Property | Description | Required |
32
32
| -------- | ----------- | -------- |
33
-
| imagePullPolicy |When to pull the image in either *OnCreate* or *Never* (*Never*can be used if the image is already on the device)| Yes |
33
+
| imagePullPolicy |Specifies when to pull the image: *OnCreate* or *Never*. Use *Never* if the image is already on the device.| Yes |
34
34
| restartPolicy | When the module should be restarted. Possible values are: *Never*: don't restart module if not running, *Always*: always restart module if not running, *On-Unhealthy*: restart module if unhealthy. Unhealthy is what Docker reports based on a health check, for example "Unhealthy - the container is not working correctly", *On-Failed*: restart if Failed. | Yes |
35
-
| runtime.type |Has to be *docker*. | Yes |
36
-
| runtime.settings.minDockerVersion |Set to the minimum Docker version required by this deployment manifest. | Yes |
37
-
| runtime.settings.loggingOptions |A stringified JSON containing the logging options for the IoT Edge agent container. [Docker logging options](https://docs.docker.com/engine/admin/logging/overview/)| No |
38
-
| runtime.settings.registryCredentials.{registryId}.username |The username of the container registry. For Azure Container Registry, the username is usually the registry name. Registry credentials are necessary for any private module images. | No |
35
+
| runtime.type |Must be *docker*. | Yes |
36
+
| runtime.settings.minDockerVersion |Specifies the minimum Docker version required by this deployment manifest. | Yes |
37
+
| runtime.settings.loggingOptions |Specifies a stringified JSON with the logging options for the IoT Edge agent container. Learn more about [Docker logging options](https://docs.docker.com/engine/admin/logging/overview/).| No |
38
+
| runtime.settings.registryCredentials.{registryId}.username |Specifies the username of the container registry. For Azure Container Registry, the username is usually the registry name. Registry credentials are required for private module images. | No |
39
39
| runtime.settings.registryCredentials.{registryId}.password | The password for the container registry. | No |
40
40
| runtime.settings.registryCredentials.{registryId}.address | The address of the container registry. For Azure Container Registry, the address is usually *{registry name}.azurecr.io*. | No |
41
-
| schemaVersion |Either *1.0* or *1.1*. Version 1.1 was introduced with IoT Edge version 1.0.10, and is recommended. | Yes |
41
+
| schemaVersion |Specifies either *1.0* or *1.1*. Version 1.1, introduced with IoT Edge version 1.0.10, is recommended. | Yes |
42
42
| status | Desired status of the module: *Running* or *Stopped*. | Required |
43
43
| systemModules.edgeAgent.type | Has to be *docker*. | Yes |
44
-
| systemModules.edgeAgent.startupOrder |An integer value for the location a module has in the startup order. A *0* is first and *max integer* (4294967295) is last. If a value isn't provided, the default is *max integer*. | No |
45
-
| systemModules.edgeAgent.settings.image |The URI of the image of the IoT Edge agent. Currently, the IoT Edge agent isn't able to update itself. | Yes |
46
-
| systemModules.edgeAgent.settings.createOptions |A stringified JSON containing the options for the creation of the IoT Edge agent container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate)| No |
44
+
| systemModules.edgeAgent.startupOrder |Specifies an integer for the module's position in the startup order. *0* is first, and *max integer* (4294967295) is last. If no value is provided, the default is *max integer*. | No |
45
+
| systemModules.edgeAgent.settings.image |Specifies the URI of the IoT Edge agent image. The IoT Edge agent can't update itself. | Yes |
46
+
| systemModules.edgeAgent.settings.createOptions |Specifies a stringified JSON with options for creating the IoT Edge agent container. Learn more about [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate).| No |
47
47
| systemModules.edgeAgent.configuration.id | The ID of the deployment that deployed this module. | IoT Hub sets this property when the manifest is applied using a deployment. Not part of a deployment manifest. |
48
48
| systemModules.edgeHub.type | Has to be *docker*. | Yes |
49
49
| systemModules.edgeHub.status | Has to be *running*. | Yes |
@@ -66,26 +66,26 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
66
66
67
67
## EdgeAgent reported properties
68
68
69
-
The IoT Edge agent reported properties include three main pieces of information:
69
+
IoT Edge agent reported properties include three main pieces of information:
70
70
71
-
1.The status of the application of the last-seen desired properties;
72
-
2.The status of the modules currently running on the device, as reported by the IoT Edge agent; and
73
-
3.A copy of the desired properties currently running on the device.
71
+
1.Status of the application of the last-seen desired properties,
72
+
2.Status of the modules currently running on the device as reported by the IoT Edge agent, and
73
+
3.Copy of the desired properties currently running on the device.
74
74
75
-
The copy of the current desired properties is useful to tell whether the device has applied the latest deployment or is still running a previous deployment manifest.
75
+
The copy of the current desired properties helps determine if the device has applied the latest deployment or is still running a previous deployment manifest.
76
76
77
77
> [!NOTE]
78
-
> The reported properties of the IoT Edge agent are useful as they can be queried with the [IoT Hub query language](../iot-hub/iot-hub-devguide-query-language.md) to investigate the status of deployments at scale. For more information on how to use the IoT Edge agent properties for status, see[Understand IoT Edge deployments for single devices or at scale](module-deployment-monitoring.md).
78
+
> You can query IoT Edge agent reported properties with the [IoT Hub query language](../iot-hub/iot-hub-devguide-query-language.md) to investigate deployment status at scale. Learn how to use IoT Edge agent properties for status in[Understand IoT Edge deployments for single devices or at scale](module-deployment-monitoring.md).
79
79
80
80
The following table does not include the information that is copied from the desired properties.
81
81
82
82
| Property | Description |
83
83
| -------- | ----------- |
84
-
| lastDesiredStatus.code |This status code refers to the last desired properties seen by the IoT Edge agent. Allowed values: `200` Success, `400` Invalid configuration, `412` Invalid schema version, `417` Desired properties are empty, `500` Failed.|
84
+
| lastDesiredStatus.code |Status code for the last desired properties seen by the IoT Edge agent. Allowed values: `200` Success, `400` Invalid configuration, `412` Invalid schema version, `417` Desired properties are empty, `500` Failed.|
85
85
| lastDesiredStatus.description | Text description of the status. |
86
86
| lastDesiredVersion | This integer refers to the last version of the desired properties processed by the IoT Edge agent. |
87
-
| runtime.platform.OS |Reporting the OS running on the device. |
88
-
| runtime.platform.architecture |Reporting the architecture of the CPU on the device. |
87
+
| runtime.platform.OS |Reports the OS running on the device. |
88
+
| runtime.platform.architecture |Reports the CPU architecture on the device. |
89
89
| schemaVersion | Schema version of reported properties. |
90
90
| systemModules.edgeAgent.runtimeStatus | The reported status of IoT Edge agent: {*running*\|*unhealthy*}. |
91
91
| systemModules.edgeAgent.statusDescription | Text description of the reported status of the IoT Edge agent. |
0 commit comments