Query - Get Twins

Servizio:

IoT Hub

Versione API:

2021-04-12

Eseguire una query su un hub IoT per recuperare informazioni relative ai dispositivi gemelli usando un linguaggio simile a SQL. Per altre informazioni, vedere https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. La paginazione è supportata. Vengono restituite informazioni solo sui dispositivi gemelli.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string	Versione dell'API.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-continuation		string	Token di continuazione usato per ottenere la pagina successiva dei risultati.
x-ms-max-item-count		string	Numero massimo di elementi restituiti per pagina. Il servizio può usare un valore diverso se il valore specificato non è accettabile.

Corpo della richiesta

Nome	Tipo	Descrizione
query	string	Stringa di query.

Risposte

Nome	Tipo	Descrizione
200 OK	Twin[]	OK. Intestazioni x-ms-item-type: string x-ms-continuation: string

Definizioni

Nome	Descrizione
DeviceCapabilities	Stato delle funzionalità abilitate nel dispositivo.
QuerySpecification	Richiesta di query Json.
Twin	Informazioni sullo stato per un dispositivo o un modulo. Questa operazione viene creata ed eliminata in modo implicito quando l'identità del dispositivo/modulo corrispondente viene creata o eliminata nel hub IoT.
TwinProperties	Proprietà desiderate e segnalate del gemello. La profondità massima dell'oggetto è 10.
X509Thumbprint

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.

Nome	Tipo	Descrizione
iotEdge	boolean	Proprietà che determina se il dispositivo è un dispositivo perimetrale o meno.

QuerySpecification

Richiesta di query Json.

Nome	Tipo	Descrizione
query	string	Stringa di query.

Twin

Informazioni sullo stato per un dispositivo o un modulo. Questa operazione viene creata ed eliminata in modo implicito quando l'identità del dispositivo/modulo corrispondente viene creata o eliminata nel hub IoT.

Nome	Tipo	Descrizione
authenticationType	enum: certificateAuthority none sas selfSigned	Tipo di autenticazione usato dal dispositivo.
capabilities	DeviceCapabilities	Stato delle funzionalità abilitate nel dispositivo.
cloudToDeviceMessageCount	integer	Numero di messaggi da cloud a dispositivo inviati.
connectionState	enum: Connected Disconnected	Stato di connessione del dispositivo.
deviceEtag	string	Stringa che rappresenta un ETag per il dispositivo, in base RFC7232.
deviceId	string	Identificatore univoco del dispositivo nel registro delle identità del hub IoT. Si tratta di una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri char) di caratteri alfanumerici ASCII a 7 bit, e i caratteri speciali seguenti {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope	string	Ambito del dispositivo.
etag	string	Stringa che rappresenta un ETag per il dispositivo gemello, in base RFC7232.
lastActivityTime	string	Data e ora dell'ultima connessione o ricezione del dispositivo o dell'invio di un messaggio. La data e l'ora vengono specificate in ISO8601 formato datetime in formato UTC, ad esempio 2015-01-28T16:24:48.789Z. Questo valore non viene aggiornato se il dispositivo usa il protocollo HTTP/1 per eseguire operazioni di messaggistica.
moduleId	string	Identificatore univoco del modulo nel registro delle identità del hub IoT. Si tratta di una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri char) di caratteri alfanumerici ASCII a 7 bit, e i caratteri speciali seguenti {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes	string[]	Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Disponibile solo per i dispositivi perimetrali.
properties	TwinProperties	Proprietà desiderate e segnalate del gemello.
status	enum: disabled enabled	Stato abilitato del dispositivo. Se disabilitato, il dispositivo non può connettersi al servizio.
statusReason	string	Motivo dello stato corrente del dispositivo, se presente.
statusUpdateTime	string	Data e ora dell'ultimo aggiornamento dello stato del dispositivo.
tags	object	Raccolta di coppie chiave-valore lette e scritte dal back-end della soluzione. Non sono visibili alle app del dispositivo. Le chiavi sono con codifica UTF-8, con distinzione tra maiuscole e minuscole e con lunghezza massima di 1 KB. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori sono oggetti JSON, di lunghezza massima di 4 KB.
version	integer	Versione del dispositivo gemello che include tag e proprietà desiderate
x509Thumbprint	X509Thumbprint	Identificazione personale X509 del dispositivo.

TwinProperties

Proprietà desiderate e segnalate del gemello. La profondità massima dell'oggetto è 10.

Nome	Tipo	Descrizione
desired	object	Raccolta di coppie chiave-valore della proprietà desiderate. Le chiavi sono con codifica UTF-8, con distinzione tra maiuscole e minuscole e lunghezza massima di 1 KB. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori di porperty desiderati sono oggetti JSON, fino a 4 KB di lunghezza.
reported	object	Raccolta di coppie chiave-valore della proprietà segnalate. Le chiavi sono con codifica UTF-8, con distinzione tra maiuscole e minuscole e lunghezza massima di 1 KB. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori delle proprietà segnalate sono oggetti JSON, di lunghezza massima di 4 KB.

X509Thumbprint

Nome	Tipo	Descrizione
primaryThumbprint	string	Identificazione personale primaria del certificato client X509.
secondaryThumbprint	string	Identificazione personale secondaria del certificato client X509.