Devices - Get Twin

Ottiene il dispositivo gemello. Per altre informazioni, vedere https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

GET https://fully-qualified-iothubname.azure-devices.net/twins/{id}?api-version=2020-05-31-preview

Parametri dell'URI

Name In Required Type Description
id
path True
  • string

Identificatore univoco del dispositivo.

api-version
query True
  • string

Versione dell'API.

Risposte

Name Type Description
200 OK

OK.

Definizioni

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.

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 nella hub IoT.

TwinProperties

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

X509Thumbprint

DeviceCapabilities

Stato delle funzionalità abilitate nel dispositivo.

Name Type Description
iotEdge
  • boolean

Proprietà che determina se il dispositivo è un dispositivo perimetrale o meno.

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 nella hub IoT.

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

Tipo di autenticazione usato dal dispositivo.

capabilities

Stato delle funzionalità abilitate nel dispositivo.

cloudToDeviceMessageCount
  • integer

Numero di messaggi da cloud a dispositivo inviati.

connectionState enum:
  • Connected
  • Disconnected

Stato della connessione del dispositivo.

deviceEtag
  • string

Stringa che rappresenta un ETag per il dispositivo, come per RFC7232.

deviceId
  • string

Identificatore univoco del dispositivo nel Registro identità del hub IoT. È una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri) di caratteri alfanumerici a 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, come per RFC7232.

lastActivityTime
  • string

Data e ora in cui il dispositivo è stato connesso o ricevuto o inviato un messaggio. La data e l'ora vengono specificate in formato DATETIME ISO8601 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 di sistema delle identità del hub IoT. È una stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri) di caratteri alfanumerici a ASCII a 7 bit, e i caratteri speciali seguenti {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(',', '=', '@', '@', '', '$', ''}.

properties

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 letti e scritti dal back-end della soluzione. Non sono visibili alle app del dispositivo. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori sono oggetti JSON, fino a 4 KB in lunghezza.

version
  • integer

Versione per il dispositivo gemello, inclusi tag e proprietà desiderate

x509Thumbprint

Identificazione personale X509 del dispositivo.

TwinProperties

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

Name Type Description
desired
  • object

Raccolta di coppie chiave-valore della proprietà desiderate. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. 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 chiave-valore della proprietà segnalate. Le chiavi sono codificate UTF-8, con distinzione tra maiuscole e minuscole e fino a 1 KB di lunghezza. I caratteri consentiti escludono caratteri di controllo UNICODE (segmenti C0 e C1), '.', '$' e spazio. I valori delle proprietà segnalate sono oggetti JSON, fino a 4 KB di lunghezza.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Identificazione personale primaria del certificato client X509.

secondaryThumbprint
  • string

Identificazione personale secondaria del certificato client X509.