Devices - Get Devices
Возвращает удостоверения нескольких устройств из реестра удостоверений Центр Интернета вещей. Не рекомендуется. Используйте API запросов Центр Интернета вещей для получения сведений о двойниках устройств и удостоверениях устройства. Дополнительные сведения см. в разделах https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub и https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
GET https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12GET https://fully-qualified-iothubname.azure-devices.net/devices?top={top}&api-version=2021-04-12Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Версия API. |
|
top
|
query |
integer int32 |
Максимальное количество удостоверений устройств, возвращаемых запросом. Любое значение вне диапазона от 1 до 1000 считается 1000. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Device[] |
Все в порядке. |
Определения
| Имя | Описание |
|---|---|
|
Authentication |
|
| Device | |
|
Device |
Состояние возможностей, включенных на устройстве. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Имя | Тип | Описание |
|---|---|---|
| symmetricKey |
Первичный и вторичный ключи, используемые для проверки подлинности на основе SAS. |
|
| type |
enum:
|
Тип проверки подлинности, используемый для подключения к службе. |
| x509Thumbprint |
Первичные и вторичные отпечатки x509, используемые для проверки подлинности на основе x509. |
Device
| Имя | Тип | Описание |
|---|---|---|
| authentication |
Механизм проверки подлинности, используемый устройством. |
|
| capabilities |
Набор возможностей устройства. Например, если это устройство является пограничным устройством или нет. |
|
| cloudToDeviceMessageCount |
integer |
Количество сообщений из облака на устройство, которые в настоящее время находятся в очереди для отправки на устройство. |
| connectionState |
enum:
|
Состояние устройства. |
| connectionStateUpdatedTime |
string |
Дата и время последнего обновления состояния подключения. |
| deviceId |
string |
Уникальный идентификатор устройства. |
| deviceScope |
string |
Область действия устройства. Автоматически создаваемые и неизменяемые для пограничных устройств и изменяемые на конечных устройствах для создания связи между дочерними и родительскими элементами. |
| etag |
string |
Строка, представляющая слабый ETag для удостоверения устройства в RFC7232. |
| generationId |
string |
Созданная Центр Интернета вещей строка с учетом регистра длиной до 128 символов. Это значение позволяет различать устройства с одинаковым свойством deviceId, которые были удалены, а затем созданы повторно. |
| lastActivityTime |
string |
Дата и время последнего подключения, получения или отправки сообщения устройством. |
| parentScopes |
string[] |
Области пограничных устройств верхнего уровня, если применимо. Доступно только для пограничных устройств. |
| status |
enum:
|
Состояние устройства. Если состояние отключено, устройство не может подключиться к службе. |
| statusReason |
string |
Строка длиной 128 символов, в которой хранится причина состояния удостоверения устройства. Разрешены все символы UTF-8. |
| statusUpdatedTime |
string |
Дата и время последнего обновления поля состояния. |
DeviceCapabilities
Состояние возможностей, включенных на устройстве.
| Имя | Тип | Описание |
|---|---|---|
| iotEdge |
boolean |
Свойство, определяющее, является ли устройство пограничным устройством. |
SymmetricKey
| Имя | Тип | Описание |
|---|---|---|
| primaryKey |
string |
Первичный ключ устройства в кодировке Base64. |
| secondaryKey |
string |
Вторичный ключ устройства в кодировке Base64. |
X509Thumbprint
| Имя | Тип | Описание |
|---|---|---|
| primaryThumbprint |
string |
Основной отпечаток сертификата клиента X509. |
| secondaryThumbprint |
string |
Вторичный отпечаток сертификата клиента X509. |