Skip to content

Commit bd3dae9

Browse files
committed
Move auto reprovisioning to global section
1 parent c34e3d4 commit bd3dae9

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

articles/iot-edge/configure-device.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Configure Azure IoT Edge device settings
33
description: This article shows you how to configure Azure IoT Edge device settings and options using the config.toml file.
44
author: PatAltimore
55
ms.author: patricka
6-
ms.date: 3/6/2023
6+
ms.date: 04/20/2023
77
ms.topic: how-to
88
ms.service: iot-edge
99
services: iot-edge
@@ -17,7 +17,7 @@ A template containing all options can be found in the *config.toml.edge.template
1717

1818
## Global parameters
1919

20-
The `hostname`, `parent_hostname`, `trust_bundle_cert`, and `allow_elevated_docker_permissions` parameters must be at the beginning of the configuration file before any other sections. Adding parameters before defined sections ensures they're applied correctly. For more information on valid syntax, see [toml.io ](https://toml.io/).
20+
The `hostname`, `parent_hostname`, `trust_bundle_cert`, `allow_elevated_docker_permissions`, and `auto_reprovisioning_mode` parameters must be at the beginning of the configuration file before any other sections. Adding parameters before defined sections ensures they're applied correctly. For more information on valid syntax, see [toml.io ](https://toml.io/).
2121

2222
### Hostname
2323

@@ -64,6 +64,26 @@ If no modules require privileged or extra capabilities, use **allow_elevated_doc
6464
allow_elevated_docker_permissions = false
6565
```
6666

67+
### Optional auto reprovisioning mode
68+
69+
The **auto_reprovisioning_mode** parameter specifies the conditions that decide when a device attempts to automatically reprovision with Device Provisioning Service. Auto provisioning mode is ignored if the device has been provisioned manually. For more information about setting DPS provisioning mode, see the [Provisioning](#provisioning) section in this article for more information.
70+
71+
One of the following values can be set:
72+
73+
| Mode | Description |
74+
|------|-------------|
75+
| Dynamic | Reprovision when the device detects that it may have been moved from one IoT Hub to another. This mode is *the default*. |
76+
| AlwaysOnStartup | Reprovision when the device is rebooted or a crash causes the daemons to restart. |
77+
| OnErrorOnly | Never trigger device reprovisioning automatically. Device reprovisioning only occurs as fallback, if the device is unable to connect to IoT Hub during identity provisioning due to connectivity errors. This fallback behavior is implicit in Dynamic and AlwaysOnStartup modes as well. |
78+
79+
For example:
80+
81+
```toml
82+
auto_reprovisioning_mode = "Dynamic"
83+
```
84+
85+
For more information about device reprovisioning, see [IoT Hub Device reprovisioning concepts](../iot-dps/concepts-device-reprovision.md).
86+
6787
## Provisioning
6888

6989
You can provision a single device or multiple devices at-scale, depending on the needs of your IoT Edge solution. The options available for authenticating communications between your IoT Edge devices and your IoT hubs depend on what provisioning method you choose.
@@ -210,24 +230,6 @@ cloud_timeout_sec = 10
210230
cloud_retries = 1
211231
```
212232

213-
### Optional auto reprovisioning mode
214-
215-
The **auto_reprovisioning_mode** parameter specifies the conditions that decide when a device attempts to automatically reprovision with Device Provisioning Service. It's ignored if the device has been provisioned manually. One of the following values can be set:
216-
217-
| Mode | Description |
218-
|------|-------------|
219-
| Dynamic | Reprovision when the device detects that it may have been moved from one IoT Hub to another. This mode is *the default*. |
220-
| AlwaysOnStartup | Reprovision when the device is rebooted or a crash causes the daemons to restart. |
221-
| OnErrorOnly | Never trigger device reprovisioning automatically. Device reprovisioning only occurs as fallback, if the device is unable to connect to IoT Hub during identity provisioning due to connectivity errors. This fallback behavior is implicit in Dynamic and AlwaysOnStartup modes as well. |
222-
223-
For example:
224-
225-
```toml
226-
auto_reprovisioning_mode = Dynamic
227-
```
228-
229-
For more information about device reprovisioning, see [IoT Hub Device reprovisioning concepts](../iot-dps/concepts-device-reprovision.md).
230-
231233
## Certificate issuance
232234

233235
If you configured any dynamically issued certs, choose your corresponding issuance method and replace the sample values with your own.

0 commit comments

Comments
 (0)