Devices - Get Identity

  • Ссылка
Service:
IoT Hub
API Version:
2020-05-31-preview

Возвращает устройство из реестра удостоверений Центр Интернета вещей.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2020-05-31-preview

Параметры URI

Имя В Обязательно Тип Описание
id
 path True

string

Уникальный идентификатор устройства.
api-version
 query True

string

Версия API.

Ответы

Имя Тип Описание
200 OK

Device

Все в порядке.

Определения

Имя Описание
AuthenticationMechanism
Device
DeviceCapabilities

Состояние возможностей, включенных на устройстве.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Имя Тип Описание
symmetricKey

SymmetricKey

Первичный и вторичный ключи, используемые для проверки подлинности на основе SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Тип проверки подлинности, используемый для подключения к службе.
x509Thumbprint

X509Thumbprint

Первичные и вторичные отпечатки x509, используемые для проверки подлинности на основе x509.

Device

Имя Тип Описание
authentication

AuthenticationMechanism

Механизм проверки подлинности, используемый устройством.
capabilities

DeviceCapabilities

Набор возможностей устройства. Например, является ли это пограничным устройством.
cloudToDeviceMessageCount

integer

Количество сообщений из облака на устройство, которые в настоящее время находятся в очереди для отправки на устройство.
connectionState enum:
  • Connected
  • Disconnected

Состояние устройства.
connectionStateUpdatedTime

string

Дата и время последнего обновления состояния подключения.
deviceId

string

Уникальный идентификатор устройства.
deviceScope

string

Область действия устройства. Автоматически создаваемые и неизменяемые для пограничных устройств и изменяемые на конечных устройствах для создания связи между дочерними и родительскими устройствами.
etag

string

Строка, представляющая слабый ETag для удостоверения устройства в RFC7232.
generationId

string

Строка, созданная Центр Интернета вещей с учетом регистра длиной до 128 символов. Это значение позволяет различать устройства с одинаковым свойством deviceId, которые были удалены, а затем созданы повторно.
lastActivityTime

string

Дата и время последнего подключения, получения или отправки сообщения устройством.
status enum:
  • disabled
  • enabled

Состояние устройства. Если состояние отключено, устройство не может подключиться к службе.
statusReason

string

Строка длиной 128 символов, в которой хранится причина для состояния удостоверения устройства. Разрешены все символы UTF-8.
statusUpdatedTime

string

Дата и время последнего обновления поля состояния.

DeviceCapabilities

Состояние возможностей, включенных на устройстве.

Имя Тип Описание
iotEdge

boolean

Свойство, определяющее, является ли устройство пограничным устройством.

SymmetricKey

Имя Тип Описание
primaryKey

string

Первичный ключ устройства в кодировке Base64.
secondaryKey

string

Вторичный ключ устройства в кодировке Base64.

X509Thumbprint

Имя Тип Описание
primaryThumbprint

string

Основной отпечаток сертификата клиента X509.
secondaryThumbprint

string

Дополнительный отпечаток сертификата клиента X509.