Query - Get Twins
Dotazem služby IoT Hub načtěte informace týkající se dvojčat zařízení pomocí jazyka podobného JAZYKu SQL. Další informace najdete v tématu https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Podporuje se stránkování. Tato funkce vrátí pouze informace o dvojčatech zařízení.
POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Verze rozhraní API |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Token pro pokračování použitý k získání další stránky výsledků. |
|
| x-ms-max-item-count |
string |
Maximální počet vrácených položek na stránku. Služba může použít jinou hodnotu, pokud zadaná hodnota není přijatelná. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| query |
string |
Řetězec dotazu. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Twin[] |
OK. Hlavičky
|
Definice
| Name | Description |
|---|---|
|
Device |
Stav funkcí povolených na zařízení. |
|
Query |
Požadavek na dotaz JSON. |
| Twin |
Informace o stavu zařízení nebo modulu To se implicitně vytvoří a odstraní, když se v IoT Hubu vytvoří nebo odstraní odpovídající identita zařízení nebo modulu. |
|
Twin |
Požadované a ohlášené vlastnosti dvojčete. Maximální hloubka objektu je 10. |
| X509Thumbprint |
DeviceCapabilities
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. |
QuerySpecification
Požadavek na dotaz JSON.
| Name | Typ | Description |
|---|---|---|
| query |
string |
Řetězec dotazu. |
Twin
Informace o stavu zařízení nebo modulu To se implicitně vytvoří a odstraní, když se v IoT Hubu vytvoří nebo odstraní odpovídající identita zařízení nebo modulu.
| Name | Typ | Description |
|---|---|---|
| authenticationType |
enum:
|
Typ ověřování používaný zařízením. |
| capabilities |
Stav funkcí povolených na zařízení. |
|
| cloudToDeviceMessageCount |
integer (int32) |
Počet odeslaných zpráv typu cloud-zařízení |
| connectionState |
enum:
|
Stav připojení zařízení. |
| deviceEtag |
string |
Řetězec představující značku ETag pro zařízení podle RFC7232. |
| deviceId |
string |
Jedinečný identifikátor zařízení v registru identit služby IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků dlouhý) 7bitové alfanumerické znaky ASCII, a následující speciální znaky {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
Rozsah zařízení. |
| etag |
string |
Řetězec představující značku ETag dvojčete zařízení podle RFC7232. |
| lastActivityTime |
string (date-time) |
Datum a čas posledního připojení nebo přijetí nebo odeslání zprávy zařízení. Datum a čas jsou v ISO8601 formátu data a času v UTC, například 2015-01-28T16:24:48.789Z. Tato hodnota se neaktualizuje, pokud zařízení k provádění operací zasílání zpráv používá protokol HTTP/1. |
| moduleId |
string |
Jedinečný identifikátor modulu v registru identit služby IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků dlouhý) 7bitové alfanumerické znaky ASCII, a následující speciální znaky {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Rozsahy hraničních zařízení nejvyšší úrovně, pokud je to možné. K dispozici pouze pro hraniční zařízení. |
| properties |
Požadované a ohlášené vlastnosti dvojčete. |
|
| status |
enum:
|
Stav zařízení je povolený. Pokud je zakázané, zařízení se nemůže připojit ke službě. |
| statusReason |
string |
Důvod aktuálního stavu zařízení, pokud existuje. |
| statusUpdateTime |
string (date-time) |
Datum a čas poslední aktualizace stavu zařízení. |
| tags |
object |
Kolekce párů klíč-hodnota přečtených a zapsaných back-endem řešení. Nejsou viditelné pro aplikace zařízení. Klíče jsou kódované UTF-8, rozlišují velká a malá písmena a up-to délku 1 kB. Povolené znaky vylučují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON, up-to o délce 4 kB. |
| version |
integer (int64) |
Verze dvojčete zařízení včetně značek a požadovaných vlastností |
| x509Thumbprint |
Kryptografický otisk X509 zařízení. |
TwinProperties
Požadované a ohlášené vlastnosti dvojčete. Maximální hloubka objektu je 10.
| Name | Typ | Description |
|---|---|---|
| desired |
object |
Kolekce dvojic klíč-hodnota požadované vlastnosti. Klíče jsou kódované UTF-8, rozlišují velká a malá písmena a up-to délku 1 kB. Povolené znaky vylučují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Požadované hodnoty porperty jsou objekty JSON up-to o délce 4 kB. |
| reported |
object |
Kolekce ohlášených párů klíč-hodnota vlastnosti. Klíče jsou kódované UTF-8, rozlišují velká a malá písmena a up-to délku 1 kB. Povolené znaky vylučují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hlášené hodnoty vlastností jsou objekty JSON, up-to o délce 4 kB. |
X509Thumbprint
| 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. |