Delen via


Query - Get Twins

Voer een query uit op een IoT Hub om informatie over apparaatdubbels op te halen met behulp van een SQL-achtige taal. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language voor meer informatie. Paginering wordt ondersteund. Dit retourneert alleen informatie over apparaatdubbels.

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

URI-parameters

Name In Vereist Type Description
api-version
query True

string

Versie van de API.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-continuation

string

Het vervolgtoken dat wordt gebruikt om de volgende pagina met resultaten op te halen.

x-ms-max-item-count

string

Het maximum aantal items dat per pagina wordt geretourneerd. De service kan een andere waarde gebruiken als de opgegeven waarde niet acceptabel is.

Aanvraagbody

Name Type Description
query

string

De querytekenreeks.

Antwoorden

Name Type Description
200 OK

Twin[]

OK.

Kopteksten

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

Definities

Name Description
DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.

QuerySpecification

De Json-queryaanvraag.

Twin

De statusinformatie voor een apparaat of module. Dit wordt impliciet gemaakt en verwijderd wanneer de bijbehorende apparaat-/module-id wordt gemaakt of verwijderd in de IoT Hub.

TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel. De maximale diepte van het object is 10.

X509Thumbprint

DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.

Name Type Description
iotEdge

boolean

De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet.

QuerySpecification

De Json-queryaanvraag.

Name Type Description
query

string

De querytekenreeks.

Twin

De statusinformatie voor een apparaat of module. Dit wordt impliciet gemaakt en verwijderd wanneer de bijbehorende apparaat-/module-id wordt gemaakt of verwijderd in de IoT Hub.

Name Type Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Het verificatietype dat door het apparaat wordt gebruikt.

capabilities

DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.

cloudToDeviceMessageCount

integer

Het aantal verzonden cloud-naar-apparaat-berichten.

connectionState enum:
  • Connected
  • Disconnected

De verbindingsstatus van het apparaat.

deviceEtag

string

De tekenreeks die een ETag voor het apparaat vertegenwoordigt, volgens RFC7232.

deviceId

string

De unieke id van het apparaat in het identiteitsregister van de IoT Hub. Het is een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) van ASCII 7-bits alfanumerieke tekens, en de volgende speciale tekens {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

deviceScope

string

Het bereik van het apparaat.

etag

string

De tekenreeks die een ETag voor de apparaatdubbel vertegenwoordigt, volgens RFC7232.

lastActivityTime

string

De datum en tijd waarop het apparaat voor het laatst verbinding heeft gemaakt of een bericht heeft ontvangen of verzonden. De datum en tijd worden gescheiden in ISO8601 datum/tijd-notatie in UTC, bijvoorbeeld 2015-01-28T16:24:48.789Z. Deze waarde wordt niet bijgewerkt als het apparaat het HTTP/1-protocol gebruikt om berichtenbewerkingen uit te voeren.

moduleId

string

De unieke id van de module in het identiteitsregister van de IoT Hub. Het is een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) van ASCII 7-bits alfanumerieke tekens, en de volgende speciale tekens {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

parentScopes

string[]

De bereiken van de randapparaten op het hoogste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten.

properties

TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel.

status enum:
  • disabled
  • enabled

De ingeschakelde status van het apparaat. Als dit is uitgeschakeld, kan het apparaat geen verbinding maken met de service.

statusReason

string

De reden voor de huidige status van het apparaat, indien van toepassing.

statusUpdateTime

string

De datum en tijd waarop de status van het apparaat voor het laatst is bijgewerkt.

tags

object

De verzameling sleutel-waardeparen die worden gelezen en geschreven door de back-end van de oplossing. Ze zijn niet zichtbaar voor apparaat-apps. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn geen UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De waarden zijn JSON-objecten met een lengte van maximaal 4 kB.

version

integer

De versie voor de apparaatdubbel, inclusief tags en gewenste eigenschappen

x509Thumbprint

X509Thumbprint

De X509-vingerafdruk van het apparaat.

TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel. De maximale diepte van het object is 10.

Name Type Description
desired

object

De verzameling van gewenste eigenschapssleutel-waardeparen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn geen UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gewenste porperty-waarden zijn JSON-objecten met een lengte van maximaal 4 kB.

reported

object

De verzameling gerapporteerde eigenschapssleutel-waardeparen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn geen UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gerapporteerde eigenschapswaarden zijn JSON-objecten met een lengte van maximaal 4 kB.

X509Thumbprint

Name Type Description
primaryThumbprint

string

De primaire vingerafdruk van het X509-clientcertificaat.

secondaryThumbprint

string

De secundaire vingerafdruk van het X509-clientcertificaat.