Devices - Get Identity

Служба:: IoT Hub

Версия API:: 2021-04-12

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

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

Параметры URI

Имя	В	Обязательно	Тип	Описание
id	path	True	string	Уникальный идентификатор устройства.
api-version	query	True	string	Версия API.

Ответы

Имя	Тип	Описание
200 OK	Device	ХОРОШО.

Определения

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

AuthenticationMechanism

Object

Имя	Тип	Описание
symmetricKey	SymmetricKey	Первичные и вторичные ключи, используемые для проверки подлинности на основе SAS.
type	enum: certificateAuthority none sas selfSigned	Тип проверки подлинности, используемый для подключения к службе.
x509Thumbprint	X509Thumbprint	Первичные и вторичные отпечатки x509, используемые для проверки подлинности на основе x509.

Device

Object

Имя	Тип	Описание
authentication	AuthenticationMechanism	Механизм проверки подлинности, используемый устройством.
capabilities	DeviceCapabilities	Набор возможностей устройства. Например, если это устройство является пограничным устройством или нет.
cloudToDeviceMessageCount	integer (int32)	Количество сообщений из облака в устройство в очередь.
connectionState	enum: Connected Disconnected	Состояние устройства.
connectionStateUpdatedTime	string (date-time)	Дата и время последнего обновления состояния подключения.
deviceId	string	Уникальный идентификатор устройства.
deviceScope	string	Область действия устройства. Автоматически созданный и неизменяемый для пограничных устройств и изменяемый на конечных устройствах для создания дочерних и родительских отношений.
etag	string	Строка, представляющая слабый ETag для удостоверения устройства, как по RFC7232.
generationId	string	Созданная в Центре Интернета вещей строка с учетом регистра длиной до 128 символов. Это значение используется для различения устройств с тем же идентификатором устройства, когда они были удалены и повторно созданы.
lastActivityTime	string (date-time)	Дата и время последнего подключения устройства, получения или отправки сообщения.
parentScopes	string[]	Области пограничных устройств верхнего уровня, если это применимо. Доступно только для пограничных устройств.
status	enum: disabled enabled	Состояние устройства. Если состояние отключено, устройство не может подключиться к службе.
statusReason	string	Строка длиной 128 символов, в которой хранится причина состояния удостоверения устройства. Разрешены все символы UTF-8.
statusUpdatedTime	string (date-time)	Дата и время последнего обновления поля состояния.

DeviceCapabilities

Object

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

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

SymmetricKey

Object

Имя	Тип	Описание
primaryKey	string	Первичный ключ устройства в кодировке Base64.
secondaryKey	string	Вторичный ключ устройства в кодировке Base64.

X509Thumbprint

Object

Имя	Тип	Описание
primaryThumbprint	string	Основной отпечаток сертификата клиента X509.
secondaryThumbprint	string	Вторичный отпечаток сертификата клиента X509.