Device - Get Device And Module In Scope

Služba:

IoT Hub

Verze rozhraní API:

2021-04-12

Získejte informace o registru zařízení pomocí modulu connect pro konkrétní zařízení v deviceScope. Další informace najdete v tématu https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Podporuje se stránkování výsledků. Tato funkce vrátí pouze informace o dvojčatech zařízení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deviceId	path	True	string
moduleId	path	True	string
api-version	query	True	string	Verze rozhraní API

Odpovědi

Name	Typ	Description
200 OK	ScopeResult	Pokud je to vhodné, získejte zařízení v oboru s tokenem pokračování.

Definice

Name	Description
AuthenticationMechanism
Device
DeviceCapabilities	Stav funkcí povolených na zařízení.
Module	Identita modulu na zařízení.
ScopeResult	Výsledek dotazu.
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.

Module

Objekt

Identita modulu na zařízení.

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování používaný modulem při připojování ke službě a hraničnímu centru.
cloudToDeviceMessageCount	integer (int32)	Počet zpráv cloud-to-module, které se mají do modulu odeslat do fronty.
connectionState	enum: Connected Disconnected	Stav připojení zařízení.
connectionStateUpdatedTime	string (date-time)	Datum a čas poslední aktualizace stavu připojení.
deviceId	string	Jedinečný identifikátor zařízení.
etag	string	Řetězec představující slabou značku ETag pro identitu modulu podle RFC7232.
generationId	string	Vygenerovaný řetězec rozlišující velká a malá písmena vygenerovaný službou IoT Hub o délce až 128 znaků. Tato hodnota se používá k rozlišení modulů se stejným ID modulu, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string (date-time)	Datum a čas posledního připojení, přijetí nebo odeslání zprávy zařízení.
managedBy	string	Identifikuje, kdo tento modul spravuje. Tato hodnota je například IotEdge, pokud modul runtime Edge vlastní tento modul.
moduleId	string	Jedinečný identifikátor modulu.

ScopeResult

Objekt

Výsledek dotazu.

Name	Typ	Description
continuationLink	string	Vyžádání tokenu pro pokračování
devices	Device[]	Položky výsledku oboru jako kolekce.
modules	Module[]	Položky výsledku oboru jako kolekce.

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.