Skip to content

Commit c42d098

Browse files
committed
Adding missing properties
1 parent 2d53a84 commit c42d098

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

articles/iot-edge/module-edgeagent-edgehub.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,16 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
3030

3131
| Property | Description | Required |
3232
| -------- | ----------- | -------- |
33-
| schemaVersion | Either "1.0" or "1.1". Version 1.1 was introduced with IoT Edge version 1.0.10, and is recommended. | Yes |
33+
| imagePullPolicy | | |
34+
| restartPolicy | | |
3435
| runtime.type | Has to be "docker" | Yes |
3536
| runtime.settings.minDockerVersion | Set to the minimum Docker version required by this deployment manifest | Yes |
3637
| 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 |
3738
| runtime.settings.registryCredentials.{registryId}.username | The username of the container registry. For Azure Container Registry, the username is usually the registry name.<br><br>Registry credentials are necessary for any private module images. | No |
3839
| runtime.settings.registryCredentials.{registryId}.password | The password for the container registry. | No |
39-
| runtime.settings.registryCredentials.{registryId}.address | The address of the container registry. For Azure Container Registry, the address is usually *{registry name}.azurecr.io*. | No |
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 |
42+
| status | | |
4043
| systemModules.edgeAgent.type | Has to be "docker" | Yes |
4144
| systemModules.edgeAgent.startupOrder | An integer value for which spot a module has in the startup order. 0 is first and max integer (4294967295) is last. If a value isn't provided, the default is max integer. | No |
4245
| 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 |
@@ -59,6 +62,7 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
5962
| modules.{moduleId}.settings.image | The URI to the module image. | Yes |
6063
| modules.{moduleId}.settings.createOptions | A stringified JSON containing the options for the creation of the module container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate) | No |
6164
| modules.{moduleId}.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. |
65+
| version | The current iteration that has version, commit, and build | |
6266

6367
## EdgeAgent reported properties
6468

@@ -77,30 +81,32 @@ The following table does not include the information that is copied from the des
7781

7882
| Property | Description |
7983
| -------- | ----------- |
80-
| lastDesiredVersion | This integer refers to the last version of the desired properties processed by the IoT Edge agent. |
8184
| 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` the desired properties are empty, `500` Failed |
8285
| lastDesiredStatus.description | Text description of the status |
86+
| lastDesiredVersion | This integer refers to the last version of the desired properties processed by the IoT Edge agent. |
8387
| runtime.platform.OS | Reporting the OS running on the device |
8488
| runtime.platform.architecture | Reporting the architecture of the CPU on the device |
89+
| schemaVersion | The IoT Edge runtime schema version |
8590
| systemModules.edgeAgent.runtimeStatus | The reported status of IoT Edge agent: {"running" \| "unhealthy"} |
86-
| systemModules.edgeAgent.statusDescription | Text description of the reported status of the IoT Edge agent. |
91+
| systemModules.edgeAgent.statusDescription | Text description of the reported status of the IoT Edge agent |
8792
| systemModules.edgeAgent.exitCode | The exit code reported by the IoT Edge agent container if the container exits |
8893
| systemModules.edgeAgent.lastStartTimeUtc | Time when IoT Edge agent was last started |
8994
| systemModules.edgeAgent.lastExitTimeUtc | Time when IoT Edge agent last exited |
9095
| systemModules.edgeHub.runtimeStatus | Status of IoT Edge hub: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
91-
| systemModules.edgeHub.statusDescription | Text description of the status of IoT Edge hub if unhealthy. |
96+
| systemModules.edgeHub.statusDescription | Text description of the status of IoT Edge hub if unhealthy |
9297
| systemModules.edgeHub.exitCode | The exit code reported by the IoT Edge hub container if the container exits |
9398
| systemModules.edgeHub.lastStartTimeUtc | Time when IoT Edge hub was last started |
9499
| systemModules.edgeHub.lastExitTimeUtc | Time when IoT Edge hub last exited |
95100
| systemModules.edgeHub.lastRestartTimeUtc | Time when IoT Edge hub was last restarted |
96-
| systemModules.edgeHub.restartCount | Number of times this module was restarted as part of the restart policy. |
101+
| systemModules.edgeHub.restartCount | Number of times this module was restarted as part of the restart policy |
97102
| modules.{moduleId}.runtimeStatus | Status of the module: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
98-
| modules.{moduleId}.statusDescription | Text description of the status of the module if unhealthy. |
103+
| modules.{moduleId}.statusDescription | Text description of the status of the module if unhealthy |
99104
| modules.{moduleId}.exitCode | The exit code reported by the module container if the container exits |
100105
| modules.{moduleId}.lastStartTimeUtc | Time when the module was last started |
101106
| modules.{moduleId}.lastExitTimeUtc | Time when the module last exited |
102107
| modules.{moduleId}.lastRestartTimeUtc | Time when the module was last restarted |
103-
| modules.{moduleId}.restartCount | Number of times this module was restarted as part of the restart policy. |
108+
| modules.{moduleId}.restartCount | Number of times this module was restarted as part of the restart policy |
109+
| version | The current iteration that has version, commit, and build |
104110

105111
## EdgeHub desired properties
106112

0 commit comments

Comments
 (0)