Devices - Get Twin

Ruft das Gerät Twin ab. Weitere Informationen finden Sie unter 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

URI-Parameter

Name In Required Type Description
id
path True
  • string

Der eindeutige Bezeichner des Geräts.

api-version
query True
  • string

Version der API.

Antworten

Name Type Description
200 OK

OK.

Definitionen

DeviceCapabilities

Der Status der funktionen, die auf dem Gerät aktiviert sind.

Twin

Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität in der IoT Hub erstellt oder gelöscht wird.

TwinProperties

Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10.

X509Thumbprint

DeviceCapabilities

Der Status der funktionen, die auf dem Gerät aktiviert sind.

Name Type Description
iotEdge
  • boolean

Die Eigenschaft, die bestimmt, ob es sich bei dem Gerät um ein Edgegerät handelt oder nicht.

Twin

Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität in der IoT Hub erstellt oder gelöscht wird.

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

Der vom Gerät verwendete Authentifizierungstyp.

capabilities

Der Status der funktionen, die auf dem Gerät aktiviert sind.

cloudToDeviceMessageCount
  • integer

Die Anzahl der gesendeten Nachrichten von Cloud-zu-Gerät.

connectionState enum:
  • Connected
  • Disconnected

Der Verbindungszustand des Geräts.

deviceEtag
  • string

Die Zeichenfolge, die ein ETag für das Gerät darstellt, gemäß RFC7232.

deviceId
  • string

Der eindeutige Bezeichner des Geräts in der Identitätsregistrierung des IoT Hub. Es handelt sich um eine Zeichenfolge mit Groß-/Kleinschreibung (bis zu 128 Zeichen lang) von ASCII 7-Bit-Alphanumerischen Zeichen, und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '', '=', '@', ';', '$', '''}.

deviceScope
  • string

Der Bereich des Geräts.

etag
  • string

Die Zeichenfolge, die ein ETag für den Geräte-Twin darstellt, gemäß RFC7232.

lastActivityTime
  • string

Das Datum und die Uhrzeit, zu dem das Gerät zuletzt verbunden oder empfangen oder eine Nachricht gesendet hat. Das Datum und die Uhrzeit werden im ISO8601-Datumstimeformat in UTC angegeben, z. B. 2015-01-28T16:24:48.789Z. Dieser Wert wird nicht aktualisiert, wenn das Gerät das HTTP/1-Protokoll zum Ausführen von Messagingvorgängen verwendet.

moduleId
  • string

Der eindeutige Bezeichner des Moduls in der Identitätsregistrierung des IoT Hub. Es handelt sich um eine Zeichenfolge mit Groß-/Kleinschreibung (bis zu 128 Zeichen lang) von ASCII 7-Bit-Alphanumerischen Zeichen, und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '', '=', '@', ';', '$', '''}.

properties

Die gewünschten und gemeldeten Eigenschaften des Zwillings.

status enum:
  • disabled
  • enabled

Der aktivierte Status des Geräts. Wenn dies deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen.

statusReason
  • string

Der Grund für den aktuellen Status des Geräts, falls vorhanden.

statusUpdateTime
  • string

Datum und Uhrzeit, zu dem der Status des Geräts zuletzt aktualisiert wurde.

tags
  • object

Die Sammlung von Schlüsselwertpaaren wird vom Lösungs-Back-End gelesen und geschrieben. Sie sind für Geräte-Apps nicht sichtbar. Sie sind UTF-8-codiert, Groß-/Kleinschreibung und bis zu 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerelementzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die Werte sind JSON-Objekte, bis zu 4 KB lang.

version
  • integer

Die Version für das Gerät Twin, einschließlich Tags und gewünschte Eigenschaften

x509Thumbprint

Der X509-Fingerabdruck des Geräts.

TwinProperties

Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10.

Name Type Description
desired
  • object

Die Auflistung der gewünschten Eigenschaftenschlüsselwertpaare. Die Schlüssel sind UTF-8 codiert, Groß-/Kleinschreibung und bis zu 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerelementzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gewünschten Porpertywerte sind JSON-Objekte, bis zu 4 KB lang.

reported
  • object

Die Auflistung der gemeldeten Eigenschaft schlüsselwertpaare. Die Schlüssel sind UTF-8 codiert, Groß-/Kleinschreibung und bis zu 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerelementzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gemeldeten Eigenschaftswerte sind JSON-Objekte, bis zu 4 KB lang.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Primärer Fingerabdruck des X509-Clientzertifikats.

secondaryThumbprint
  • string

Sekundärer Fingerabdruck des X509-Clientzertifikats.