Query - Get Twins
Fråga en IoT Hub för att hämta information om enhetstvillingar med ett SQL-liknande språk. Mer information finns i https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sidnumrering stöds. Detta returnerar endast information om enhetstvillingar.
POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version av API:et. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Fortsättningstoken som används för att hämta nästa sida med resultat. |
|
| x-ms-max-item-count |
string |
Det maximala antalet objekt som returneras per sida. Tjänsten kan använda ett annat värde om det angivna värdet inte är acceptabelt. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| query |
string |
Frågesträngen. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Twin[] |
OK. Headers
|
Definitioner
| Name | Description |
|---|---|
|
Device |
Status för funktioner som är aktiverade på enheten. |
|
Query |
Json-frågebegäran. |
| Twin |
Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub. |
|
Twin |
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10. |
| X509Thumbprint |
DeviceCapabilities
Status för funktioner som är aktiverade på enheten.
| Name | Typ | Description |
|---|---|---|
| iotEdge |
boolean |
Egenskapen som avgör om enheten är en gränsenhet eller inte. |
QuerySpecification
Json-frågebegäran.
| Name | Typ | Description |
|---|---|---|
| query |
string |
Frågesträngen. |
Twin
Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub.
| Name | Typ | Description |
|---|---|---|
| authenticationType |
enum:
|
Den autentiseringstyp som används av enheten. |
| capabilities |
Status för funktioner som är aktiverade på enheten. |
|
| cloudToDeviceMessageCount |
integer |
Antalet meddelanden från molnet till enheten som skickas. |
| connectionState |
enum:
|
Enhetens anslutningstillstånd. |
| deviceEtag |
string |
Strängen som representerar en ETag för enheten enligt RFC7232. |
| deviceId |
string |
Den unika identifieraren för enheten i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
| deviceScope |
string |
Enhetens omfång. |
| etag |
string |
Strängen som representerar en ETag för enhetstvillingen enligt RFC7232. |
| lastActivityTime |
string |
Datum och tid när enheten senast anslöt eller tog emot eller skickade ett meddelande. Datum och tid anges i ISO8601 datetime-format i UTC, till exempel 2015-01-28T16:24:48.789Z. Det här värdet uppdateras inte om enheten använder HTTP/1-protokollet för att utföra meddelandeåtgärder. |
| moduleId |
string |
Den unika identifieraren för modulen i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
| parentScopes |
string[] |
Omfången för de övre gränsenheterna om tillämpligt. Endast tillgängligt för gränsenheter. |
| properties |
Önskade och rapporterade egenskaper för tvillingen. |
|
| status |
enum:
|
Enhetens aktiverade status. Om enheten är inaktiverad kan den inte ansluta till tjänsten. |
| statusReason |
string |
Orsaken till enhetens aktuella status, om någon. |
| statusUpdateTime |
string |
Datum och tid då enhetens status senast uppdaterades. |
| tags |
object |
Samlingen nyckel/värde-par som lästs och skrivits av lösningens serverdel. De är inte synliga för enhetsappar. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Värdena är JSON-objekt med en längd på upp till 4 KB. |
| version |
integer |
Versionen för enhetstvillingen inklusive taggar och önskade egenskaper |
| x509Thumbprint |
Enhetens X509-tumavtryck. |
TwinProperties
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.
| Name | Typ | Description |
|---|---|---|
| desired |
object |
Samlingen av nyckel/värde-par för önskad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Önskade porperty-värden är JSON-objekt med en längd på upp till 4 KB. |
| reported |
object |
Samlingen av nyckel/värde-par för rapporterad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt med en längd på upp till 4 KB. |
X509Thumbprint
| Name | Typ | Description |
|---|---|---|
| primaryThumbprint |
string |
X509-klientcertifikatets primära tumavtryck. |
| secondaryThumbprint |
string |
X509-klientcertifikatets sekundära tumavtryck. |