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
+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
@@ -31,11 +31,11 @@ The module twin for the IoT Edge agent is called `$edgeAgent` and coordinates th
31
31
| Property | Description | Required |
32
32
| -------- | ----------- | -------- |
33
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 |
34
-
| restartPolicy | When the module should be restarted. Possible values are: <br><br> *Never*: don't restart module if not running <br>*Always*: always restart module if not running<br>*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". <br>*On-Failed*: restart if Failed. | Yes |
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
35
| runtime.type | Has to be *docker*. | Yes |
36
36
| runtime.settings.minDockerVersion | Set to the minimum Docker version required by this deployment manifest. | Yes |
37
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.<br><br>Registry credentials are necessary for any private module images. | 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 |
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
41
| schemaVersion | Either *1.0* or *1.1*. Version 1.1 was introduced with IoT Edge version 1.0.10, and is recommended. | Yes |
@@ -106,7 +106,7 @@ The following table does not include the information that is copied from the des
106
106
| modules.{moduleId}.lastExitTimeUtc | Time when the module was last exited. |
107
107
| modules.{moduleId}.lastRestartTimeUtc | Time when the module was last restarted. |
108
108
| modules.{moduleId}.restartCount | Number of times this module was restarted as part of the restart policy. |
109
-
| version | Version of the image. <br>Example: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
109
+
| version | Version of the image. Example: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
110
110
111
111
## EdgeHub desired properties
112
112
@@ -125,12 +125,12 @@ The module twin for the IoT Edge hub is called `$edgeHub` and coordinates the co
125
125
| lastDesiredVersion | This integer refers to the last version of the desired properties processed by the IoT Edge hub. |
126
126
| lastDesiredStatus.code | The status code referring to last desired properties seen by the IoT Edge hub. Allowed values: `200` Success, `400` Invalid configuration, `500` Failed |
127
127
| lastDesiredStatus.description | Text description of the status. |
128
-
| clients | All clients connected to edgeHub with the status and last connected time. <br>Example: "clients": { "device2/SimulatedTemperatureSensor": { "status": "Connected", "lastConnectedTimeUtc": "2022-11-17T21:49:16.4781564Z" } }. |
128
+
| clients | All clients connected to edgeHub with the status and last connected time. Example: "clients": { "device2/SimulatedTemperatureSensor": { "status": "Connected", "lastConnectedTimeUtc": "2022-11-17T21:49:16.4781564Z" } }. |
129
129
| clients.{device or moduleId}.status | The connectivity status of this device or module. Possible values {*connected*\|*disconnected*}. Only module identities can be in disconnected state. Downstream devices connecting to IoT Edge hub appear only when connected. |
130
130
| clients.{device or moduleId}.lastConnectTime | Last time the device or module connected. |
131
131
| clients.{device or moduleId}.lastDisconnectTime | Last time the device or module disconnected. |
132
132
| schemaVersion | Schema version of reported properties. |
133
-
| version | Version of the image. <br>Example: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
133
+
| version | Version of the image. Example: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
0 commit comments