Skip to content

Commit 1bdbfd0

Browse files
authored
Merge pull request #104547 from tobias-graf-p/updated-iot-edge-docs
updated iod-edge reported properties docs
2 parents e895bcb + 9f838d4 commit 1bdbfd0

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,20 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
3434
| runtime.type | Has to be "docker" | Yes |
3535
| runtime.settings.minDockerVersion | Set to the minimum Docker version required by this deployment manifest | Yes |
3636
| 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 |
37-
| runtime.settings.registryCredentials<br>.{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 |
38-
| runtime.settings.registryCredentials<br>.{registryId}.password | The password for the container registry. | No |
39-
| runtime.settings.registryCredentials<br>.{registryId}.address | The address of the container registry. For Azure Container Registry, the address is usually *{registry name}.azurecr.io*. | No |
37+
| 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 |
38+
| 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 |
4040
| systemModules.edgeAgent.type | Has to be "docker" | Yes |
41+
| 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 |
4142
| 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 |
42-
| systemModules.edgeAgent.settings<br>.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 |
43+
| 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 |
4344
| 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. |
4445
| systemModules.edgeHub.type | Has to be "docker" | Yes |
4546
| systemModules.edgeHub.status | Has to be "running" | Yes |
4647
| systemModules.edgeHub.restartPolicy | Has to be "always" | Yes |
4748
| systemModules.edgeHub.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 |
4849
| systemModules.edgeHub.settings.image | The URI of the image of the IoT Edge hub. | Yes |
49-
| systemModules.edgeHub.settings<br>.createOptions | A stringified JSON containing the options for the creation of the IoT Edge hub container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate) | No |
50+
| systemModules.edgeHub.settings.createOptions | A stringified JSON containing the options for the creation of the IoT Edge hub container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate) | No |
5051
| systemModules.edgeHub.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. |
5152
| modules.{moduleId}.version | A user-defined string representing the version of this module. | Yes |
5253
| modules.{moduleId}.type | Has to be "docker" | Yes |
@@ -83,17 +84,20 @@ The following table does not include the information that is copied from the des
8384
| runtime.platform.architecture | Reporting the architecture of the CPU on the device |
8485
| systemModules.edgeAgent.runtimeStatus | The reported status of IoT Edge agent: {"running" \| "unhealthy"} |
8586
| systemModules.edgeAgent.statusDescription | Text description of the reported status of the IoT Edge agent. |
87+
| systemModules.edgeAgent.exitCode | The exit code reported by the IoT Edge agent container if the container exits |
88+
| systemModules.edgeAgent.lastStartTimeUtc | Time when IoT Edge agent was last started |
89+
| systemModules.edgeAgent.lastExitTimeUtc | Time when IoT Edge agent last exited |
8690
| systemModules.edgeHub.runtimeStatus | Status of IoT Edge hub: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
8791
| systemModules.edgeHub.statusDescription | Text description of the status of IoT Edge hub if unhealthy. |
8892
| systemModules.edgeHub.exitCode | The exit code reported by the IoT Edge hub container if the container exits |
89-
| systemModules.edgeHub.startTimeUtc | Time when IoT Edge hub was last started |
93+
| systemModules.edgeHub.lastStartTimeUtc | Time when IoT Edge hub was last started |
9094
| systemModules.edgeHub.lastExitTimeUtc | Time when IoT Edge hub last exited |
9195
| systemModules.edgeHub.lastRestartTimeUtc | Time when IoT Edge hub was last restarted |
9296
| systemModules.edgeHub.restartCount | Number of times this module was restarted as part of the restart policy. |
9397
| modules.{moduleId}.runtimeStatus | Status of the module: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
9498
| modules.{moduleId}.statusDescription | Text description of the status of the module if unhealthy. |
9599
| modules.{moduleId}.exitCode | The exit code reported by the module container if the container exits |
96-
| modules.{moduleId}.startTimeUtc | Time when the module was last started |
100+
| modules.{moduleId}.lastStartTimeUtc | Time when the module was last started |
97101
| modules.{moduleId}.lastExitTimeUtc | Time when the module last exited |
98102
| modules.{moduleId}.lastRestartTimeUtc | Time when the module was last restarted |
99103
| modules.{moduleId}.restartCount | Number of times this module was restarted as part of the restart policy. |

0 commit comments

Comments
 (0)