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-edge/module-edgeagent-edgehub.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,19 +34,20 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
34
34
| runtime.type | Has to be "docker" | Yes |
35
35
| runtime.settings.minDockerVersion | Set to the minimum Docker version required by this deployment manifest | Yes |
36
36
| 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 |
40
40
| 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 |
41
42
| 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 |
43
44
| 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. |
44
45
| systemModules.edgeHub.type | Has to be "docker" | Yes |
45
46
| systemModules.edgeHub.status | Has to be "running" | Yes |
46
47
| systemModules.edgeHub.restartPolicy | Has to be "always" | Yes |
47
48
| 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 |
48
49
| 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 |
50
51
| 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. |
51
52
| modules.{moduleId}.version | A user-defined string representing the version of this module. | Yes |
52
53
| 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
83
84
| runtime.platform.architecture | Reporting the architecture of the CPU on the device |
84
85
| systemModules.edgeAgent.runtimeStatus | The reported status of IoT Edge agent: {"running" \| "unhealthy"} |
85
86
| 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 |
86
90
| systemModules.edgeHub.runtimeStatus | Status of IoT Edge hub: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
87
91
| systemModules.edgeHub.statusDescription | Text description of the status of IoT Edge hub if unhealthy. |
88
92
| 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 |
90
94
| systemModules.edgeHub.lastExitTimeUtc | Time when IoT Edge hub last exited |
91
95
| systemModules.edgeHub.lastRestartTimeUtc | Time when IoT Edge hub was last restarted |
92
96
| systemModules.edgeHub.restartCount | Number of times this module was restarted as part of the restart policy. |
93
97
| modules.{moduleId}.runtimeStatus | Status of the module: { "running" \| "stopped" \| "failed" \| "backoff" \| "unhealthy" } |
94
98
| modules.{moduleId}.statusDescription | Text description of the status of the module if unhealthy. |
95
99
| 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 |
97
101
| modules.{moduleId}.lastExitTimeUtc | Time when the module last exited |
98
102
| modules.{moduleId}.lastRestartTimeUtc | Time when the module was last restarted |
99
103
| modules.{moduleId}.restartCount | Number of times this module was restarted as part of the restart policy. |
0 commit comments