Query - Get Twins

Szolgáltatás:
IoT Hub
API-verzió:
2021-04-12

IoT Hub lekérdezése az ikereszközökkel kapcsolatos információk SQL-szerű nyelv használatával történő lekéréséhez. További információért lásd a https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language jelű részt. A lapozás támogatott. Ez csak az ikereszközökkel kapcsolatos információkat adja vissza.

POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12

URI-paraméterek

Name In Kötelező Típus Description
api-version
 query True

string

Az Api verziója.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-continuation

string

A következő találatoldal lekéréséhez használt folytatási jogkivonat.
x-ms-max-item-count

string

Az oldalonként visszaadott elemek maximális száma. A szolgáltatás eltérő értéket használhat, ha a megadott érték nem elfogadható.

Kérelem törzse

Name Típus Description
query

string

A lekérdezési sztring.

Válaszok

Name Típus Description
200 OK

Twin[]

OKÉ.

Fejlécek

  • x-ms-item-type: string
  • x-ms-continuation: string

Definíciók

Name Description
DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
QuerySpecification

A Json-lekérdezési kérelem.
Twin

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik az IoT Hubban.
TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.
X509Thumbprint

DeviceCapabilities

Objektum

Az eszközön engedélyezett képességek állapota.

Name Típus Description
iotEdge

boolean

Az a tulajdonság, amely meghatározza, hogy az eszköz peremeszköz-e vagy sem.

QuerySpecification

Objektum

A Json-lekérdezési kérelem.

Name Típus Description
query

string

A lekérdezési sztring.

Twin

Objektum

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik az IoT Hubban.

Name Típus Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Az eszköz által használt hitelesítési típus.
capabilities

DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
cloudToDeviceMessageCount

integer (int32)

A felhőből az eszközre küldött üzenetek száma.
connectionState enum:
  • Connected
  • Disconnected

Az eszköz kapcsolati állapota.
deviceEtag

string

Az eszköz ETag-jének sztringje a RFC7232 szerint.
deviceId

string

Az eszköz egyedi azonosítója az IoT Hub identitásjegyzékében. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Az eszköz hatóköre.
etag

string

Az ikereszköz ETag-jének sztringje a RFC7232 szerint.
lastActivityTime

string (date-time)

Az eszköz legutóbbi csatlakoztatásának vagy fogadásának vagy üzenetküldésének dátuma és időpontja. A dátum és az idő ISO8601 dátum/idő formátumban van megadva UTC-ben, például 2015-01-28T16:24:48.789Z. Ez az érték nem frissül, ha az eszköz a HTTP/1 protokollt használja az üzenetkezelési műveletek végrehajtásához.
moduleId

string

A modul egyedi azonosítója az IoT Hub identitásjegyzékében. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

A felső szintű peremeszközök hatókörei, ha vannak. Csak peremeszközökhöz érhető el.
properties

TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságai.
status enum:
  • disabled
  • enabled

Az eszköz engedélyezett állapota. Ha le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz.
statusReason

string

Az eszköz aktuális állapotának oka, ha van ilyen.
statusUpdateTime

string (date-time)

Az eszköz állapotának legutóbbi frissítésének dátuma és időpontja.
tags

object

A megoldás háttérrendszere által beolvasott és írt kulcs-érték párok gyűjteménye. Nem láthatók az eszközalkalmazások számára. Ezek a kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. Az értékek JSON-objektumok, up-to 4KB hosszúak.
version

integer (int64)

Az ikereszköz verziója, beleértve a címkéket és a kívánt tulajdonságokat
x509Thumbprint

X509Thumbprint

Az eszköz X509 ujjlenyomata.

TwinProperties

Objektum

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.

Name Típus Description
desired

object

A kívánt tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. A kívánt porperty értékek JSON-objektumok, up-to 4KB hosszúak.
reported

object

A jelentett tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. A jelentett tulajdonságértékek JSON-objektumok, up-to 4 KB hosszúak.

X509Thumbprint

Objektum
Name Típus Description
primaryThumbprint

string

Az X509 ügyféltanúsítvány elsődleges ujjlenyomata.
secondaryThumbprint

string

Az X509 ügyféltanúsítvány másodlagos ujjlenyomata.