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-central/core/howto-manage-devices-individually.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,24 +51,34 @@ The following video walks you through monitoring device connectivity status:
51
51
52
52
### Device status values
53
53
54
-
When a device connects to your IoT Central application, its device status changes as follows:
54
+
Every device has a single status value in the UI. The device status can be one of:
55
55
56
-
1. The device status is first **Registered**. This status means the device is created in IoT Central, and has a device ID. A device is registered when:
57
-
- A new real device is added on the **Devices** page.
58
-
- A set of devices is added using **Import** on the **Devices** page.
56
+
- The device status is first **Registered**. This status means the device is created in IoT Central, and has a device ID. A device is registered when:
59
57
60
-
1. The device status changes to **Provisioned** when the device that connected to your IoT Central application with valid credentials completes the provisioning step. In this step, the device uses DPS. The *Device ID* that was used to register the device. Either a SAS key or X.509 certificatTo find these values: to automatically retrieve a connection string from the IoT Hub used by your IoT Central application. The device can now connect to IoT Central and start sending data.
58
+
- A new real device is added on the **Devices** page.
59
+
- A set of devices is added using **Import** on the **Devices** page.
61
60
62
-
1. An operator can block a device. When a device is blocked, it can't send data to your IoT Central application. Blocked devices have a status of **Blocked**. An operator must reset the device before it can resume sending data. When an operator unblocks a device the status returns to its previous value, **Registered** or **Provisioned**.
61
+
- The device status changes to **Provisioned** when a registered device completes the provisioning step by using DPS. To complete the provisioning process, the device needs the *Device ID* that was used to register the device, either a SAS key or X.509 certificate, and the *ID scope*. After provisioning, the device can connect to your IoT Central application and start sending data.
63
62
64
-
1. If the device status is**Waiting for Approval**, it means the **Auto approve** option is disabled. An operator must explicitly approve a device before it starts sending data. Devices not registered manually on the **Devices** page, but connected with valid credentials have the device status **Waiting for Approval**. Operators can approve these devices from the **Devices**page using the **Approve** button.
63
+
- Blocked devices have a status of**Blocked**. An operator can block and unblock devices. When a device is blocked, it can't send data to your IoT Central application. An operator must unblock the device before it can resume sending data. When an operator unblocks a device the status returns to its previous value, **Registered**or **Provisioned**.
65
64
66
-
1. If the device status is **Unassigned**, it means the device connecting to IoT Central isn't assigned to a device template. This situation typically happens in the following scenarios:
65
+
- If the device status is **Waiting for Approval**, it means the **Auto approve** option is disabled on the **Device connection groups** page. An operator must explicitly approve a device before it can be provisioned and sending data. Devices not registered manually on the **Devices** page, but connected with valid credentials have the device status **Waiting for Approval**. Operators can approve these devices from the **Devices** page using the **Approve** button.
67
66
68
-
- A set of devices is added using **Import** on the **Devices** page without specifying the device template.
69
-
- A device was registered manually on the **Devices** page without specifying the device template. The device then connected with valid credentials.
67
+
The following table shows how the status value for a device in the UI maps to the values used by the REST API to interact with devices:
70
68
71
-
An operator can assign a device to a device template from the **Devices** page using the **Migrate** button.
69
+
| UI Device status | Notes | REST API Get |
70
+
| ---------------- | ----- | ------------ |
71
+
| Waiting for approval | The auto-approve option is disabled in the device connection group and the device was not added through the UI. <br/> A user must manually approve the device through the UI before it can be used. |`Provisioned: false` <br/> `Enabled: false`|
72
+
| Registered | A device has been approved either automatically or manually. |`Provisioned: false` <br/> `Enabled: true`|
73
+
| Provisioned | The device has been provisioned and can connect to your IoT Central application. |`Provisioned: true` <br/> `Enabled: true`|
74
+
| Blocked | The device is not allowed to connect to your IoT Central application. You can block a device that is in any of the other states. |`Provisioned:` depends on `Waiting for approval`/`Registered`/`Provisioned status` <br/> `Enabled: false`|
75
+
76
+
A device can also have a status of **Unassigned**. This status isn't shown in the **Device status** field in the UI, it is shown in the **Device template** field in the UI. However, you can filter the device list for devices with the **Unassigned** status. If the device status is **Unassigned**, the device connecting to IoT Central isn't assigned to a device template. This situation typically happens in the following scenarios:
77
+
78
+
- A set of devices is added using **Import** on the **Devices** page without specifying the device template.
79
+
- A device was registered manually on the **Devices** page without specifying the device template. The device then connected with valid credentials.
80
+
81
+
An operator can assign a device to a device template from the **Devices** page by using the **Migrate** button.
Copy file name to clipboardExpand all lines: articles/iot-central/core/howto-manage-devices-with-rest-api.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,6 +100,15 @@ The response to this request looks like the following example:
100
100
}
101
101
```
102
102
103
+
The following table shows how the status value for a device in the UI maps to the values used by the REST API to interact with devices:
104
+
105
+
| UI Device status | Notes | REST API Get |
106
+
| ---------------- | ----- | ------------ |
107
+
| Waiting for approval | The auto-approve option is disabled in the device connection group and the device was not added through the UI. <br/> A user must manually approve the device through the UI before it can be used. |`Provisioned: false` <br/> `Enabled: false`|
108
+
| Registered | A device has been approved either automatically or manually. |`Provisioned: false` <br/> `Enabled: true`|
109
+
| Provisioned | The device has been provisioned and can connect to your IoT Central application. |`Provisioned: true` <br/> `Enabled: true`|
110
+
| Blocked | The device is not allowed to connect to your IoT Central application. You can block a device that is in any of the other states. |`Provisioned:` depends on `Waiting for approval`/`Registered`/`Provisioned status` <br/> `Enabled: false`|
111
+
103
112
### Get device credentials
104
113
105
114
Use the following request to retrieve credentials of a device from your application:
| Unapproved | The device isn't approved. | Device isn't approved to connect to the IoT Central application. Approve the device in IoT Central and retry. To learn more, see [Device status values](howto-manage-devices-individually.md#device-status-values)|
136
136
| Unassigned | The device isn't assigned to a device template. | Assign the device to a device template so that IoT Central knows how to parse the data. |
137
137
138
-
Learn more about [Device status values](howto-manage-devices-individually.md#device-status-values).
138
+
Learn more about [Device status values in the UI](howto-manage-devices-individually.md#device-status-values) and [Device status values in the REST API](howto-manage-devices-with-rest-api.md#get-a-device).
0 commit comments