Devices - Get Identity

Služba:

IoT Hub

Verze rozhraní API:

2021-04-12

Získá zařízení z registru identit služby IoT Hub.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	Jedinečný identifikátor zařízení.
api-version	query	True	string	Verze rozhraní API

Odpovědi

Name	Typ	Description
200 OK	Device	OK.

Definice

Name	Description
AuthenticationMechanism
Device
DeviceCapabilities	Stav funkcí povolených na zařízení.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Objekt

Name	Typ	Description
symmetricKey	SymmetricKey	Primární a sekundární klíče používané pro ověřování na základě SAS.
type	enum: certificateAuthority none sas selfSigned	Typ ověřování sloužící k připojení ke službě.
x509Thumbprint	X509Thumbprint	Primární a sekundární kryptografické otisky x509 používané pro ověřování na základě x509.

Device

Objekt

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování používaný zařízením.
capabilities	DeviceCapabilities	Sada funkcí zařízení. Pokud je například toto zařízení hraničním zařízením nebo ne.
cloudToDeviceMessageCount	integer (int32)	Počet zpráv typu cloud-zařízení, které se mají do zařízení odeslat do fronty.
connectionState	enum: Connected Disconnected	Stav zařízení.
connectionStateUpdatedTime	string (date-time)	Datum a čas poslední aktualizace stavu připojení.
deviceId	string	Jedinečný identifikátor zařízení.
deviceScope	string	Rozsah zařízení. Automaticky generované a neměnné pro hraniční zařízení a upravitelné v zařízeních typu list pro vytvoření podřízené/nadřazené relace
etag	string	Řetězec představující slabou značku ETag pro identitu zařízení podle RFC7232.
generationId	string	Vygenerovaný řetězec s rozlišováním velkých a malých písmen v IoT Hubu o délce až 128 znaků. Tato hodnota se používá k rozlišení zařízení se stejným ID zařízení, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string (date-time)	Datum a čas posledního připojení zařízení, přijetí nebo odeslání zprávy.
parentScopes	string[]	Rozsahy hraničních zařízení nejvyšší úrovně, pokud je to možné. K dispozici pouze pro hraniční zařízení.
status	enum: disabled enabled	Stav zařízení. Pokud je stav zakázaný, zařízení se nemůže připojit ke službě.
statusReason	string	Řetězec s délkou 128 znaků, který ukládá důvod stavu identity zařízení. Jsou povoleny všechny znaky UTF-8.
statusUpdatedTime	string (date-time)	Datum a čas poslední aktualizace pole stavu.

DeviceCapabilities

Objekt

Stav funkcí povolených na zařízení.

Name	Typ	Description
iotEdge	boolean	Vlastnost, která určuje, jestli je zařízení hraničním zařízením nebo ne.

SymmetricKey

Objekt

Name	Typ	Description
primaryKey	string	Primární klíč zařízení kódovaný v base64.
secondaryKey	string	Sekundární klíč zařízení kódovaný v base64.

X509Thumbprint

Objekt

Name	Typ	Description
primaryThumbprint	string	Primární kryptografický otisk klientského certifikátu X509.
secondaryThumbprint	string	Sekundární kryptografický otisk klientského certifikátu X509.