Freigeben über


Devices - Replace Twin

Ersetzt die Tags und gewünschten Eigenschaften eines Gerätezwillens. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

PUT https://fully-qualified-iothubname.azure-devices.net/twins/{id}?api-version=2021-04-12

URI-Parameter

Name In Erforderlich Typ Beschreibung
id
path True

string

Der eindeutige Bezeichner des Geräts.

api-version
query True

string

Version der Api.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

Die Zeichenfolge, die gemäß RFC7232 ein schwaches ETag für den Gerätezwilligen darstellt. Er bestimmt, ob der Ersatzvorgang ausgeführt werden soll.

Anforderungstext

Name Typ Beschreibung
authenticationType enum:
  • sas
  • selfSigned
  • certificateAuthority
  • none

Der vom Gerät verwendete Authentifizierungstyp.

capabilities

DeviceCapabilities

Die status der auf dem Gerät aktivierten Funktionen.

cloudToDeviceMessageCount

integer

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

connectionState enum:
  • Disconnected
  • Connected

Der Verbindungsstatus des Geräts.

deviceEtag

string

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

deviceId

string

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

deviceScope

string

Der Bereich des Geräts.

etag

string

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

lastActivityTime

string

Das Datum und die Uhrzeit, zu dem das Gerät zuletzt eine Verbindung hergestellt oder eine Nachricht empfangen oder gesendet hat. Datum und Uhrzeit werden im ISO8601 datetime-Format 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. Hierbei handelt es sich um eine Zeichenfolge mit 7-Bit-alphanumerischen ASCII-Zeichen (bis zu 128 Zeichen lang), und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';,, '$', ''}.

parentScopes

string[]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Nur für Edgegeräte verfügbar.

properties

TwinProperties

Die gewünschten und gemeldeten Eigenschaften des Zwillings.

status enum:
  • enabled
  • disabled

Die aktivierte status des Geräts. Wenn es deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen.

statusReason

string

Der Grund für die aktuelle status des Geräts, falls vorhanden.

statusUpdateTime

string

Das Datum und die Uhrzeit, zu dem die status des Geräts zuletzt aktualisiert wurde.

tags

object

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

version

integer

Die Version für den Gerätezwillen, einschließlich Tags und gewünschten Eigenschaften

x509Thumbprint

X509Thumbprint

Der X509-Fingerabdruck des Geräts.

Antworten

Name Typ Beschreibung
200 OK

Twin

OK.

Definitionen

Name Beschreibung
DeviceCapabilities

Die status der auf dem Gerät aktivierten Funktionen.

Twin

Die Zustandsinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im 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

Die status der auf dem Gerät aktivierten Funktionen.

Name Typ Beschreibung
iotEdge

boolean

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

Twin

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

Name Typ Beschreibung
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Der vom Gerät verwendete Authentifizierungstyp.

capabilities

DeviceCapabilities

Die status der auf dem Gerät aktivierten Funktionen.

cloudToDeviceMessageCount

integer

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

connectionState enum:
  • Connected
  • Disconnected

Der Verbindungsstatus des Geräts.

deviceEtag

string

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

deviceId

string

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

deviceScope

string

Der Bereich des Geräts.

etag

string

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

lastActivityTime

string

Das Datum und die Uhrzeit, zu dem das Gerät zuletzt eine Verbindung hergestellt oder eine Nachricht empfangen oder gesendet hat. Datum und Uhrzeit werden im ISO8601 datetime-Format 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. Hierbei handelt es sich um eine Zeichenfolge mit 7-Bit-alphanumerischen ASCII-Zeichen (bis zu 128 Zeichen lang), und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';,, '$', ''}.

parentScopes

string[]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Nur für Edgegeräte verfügbar.

properties

TwinProperties

Die gewünschten und gemeldeten Eigenschaften des Zwillings.

status enum:
  • disabled
  • enabled

Die aktivierte status des Geräts. Wenn es deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen.

statusReason

string

Der Grund für die aktuelle status des Geräts, falls vorhanden.

statusUpdateTime

string

Das Datum und die Uhrzeit, zu dem die status des Geräts zuletzt aktualisiert wurde.

tags

object

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

version

integer

Die Version für den Gerätezwillen, einschließlich Tags und gewünschten Eigenschaften

x509Thumbprint

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 Typ Beschreibung
desired

object

Die Auflistung der gewünschten Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, beachten die Groß-/Kleinschreibung und sind bis zu 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gewünschten Porpertywerte sind JSON-Objekte mit einer Länge von bis zu 4 KB.

reported

object

Die Auflistung der gemeldeten Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, beachten die Groß-/Kleinschreibung und sind bis zu 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gemeldeten Eigenschaftswerte sind JSON-Objekte mit einer Länge von bis zu 4 KB.

X509Thumbprint

Name Typ Beschreibung
primaryThumbprint

string

Der primäre Fingerabdruck des X509-Clientzertifikats.

secondaryThumbprint

string

Der sekundäre Fingerabdruck des X509-Clientzertifikats.