Twin Klasse

Die Statusinformationen 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.

Vererbung

Model

Twin

Konstruktor

Twin(*, device_id: str = None, module_id: str = None, tags=None, properties=None, etag: str = None, version: int = None, device_etag: str = None, status=None, status_reason: str = None, status_update_time=None, connection_state=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication_type=None, x509_thumbprint=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

Parameter

device_id

str

Erforderlich

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

module_id

str

Erforderlich

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

tags

dict[str, object]

Erforderlich

Die Auflistung 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 Groß-/Kleinschreibung und eine Länge von bis zu 1 KB. 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.

properties

TwinProperties

Erforderlich

Die gewünschten und gemeldeten Eigenschaften des Zwillings.

etag

str

Erforderlich

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

version

<xref:long>

Erforderlich

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

device_etag

str

Erforderlich

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

status

str oder <xref:protocol.models.enum>

Erforderlich

Die aktivierte status des Geräts. Wenn er deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen. Mögliche Werte: "enabled", "disabled"

status_reason

str

Erforderlich

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

status_update_time

datetime

Erforderlich

Das Datum und die Uhrzeit der letzten Aktualisierung des status des Geräts.

connection_state

str oder <xref:protocol.models.enum>

Erforderlich

Der Verbindungsstatus des Geräts. Mögliche Werte: "Disconnected", "Connected"

last_activity_time

datetime

Erforderlich

Das Datum und die Uhrzeit, zu dem das Gerät zuletzt eine Nachricht hergestellt oder 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.

cloud_to_device_message_count

int

Erforderlich

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

authentication_type

str oder <xref:protocol.models.enum>

Erforderlich

Der vom Gerät verwendete Authentifizierungstyp. Mögliche Werte: "sas", "selfSigned", "certificateAuthority", "none"

x509_thumbprint

X509Thumbprint

Erforderlich

Der X509-Fingerabdruck des Geräts.

capabilities

DeviceCapabilities

Erforderlich

device_scope

str

Erforderlich

Der Bereich des Geräts.

parent_scopes

list[str]

Erforderlich

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

Methoden

as_dict	Gibt ein Dict zurück, das mit json.dump JSONify sein kann. Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden: Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt. Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet. Sehen Sie sich die drei Beispiele in dieser Datei an: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
deserialize	Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
enable_additional_properties_sending
from_dict	Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück. Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet wird. Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False). Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
validate	Überprüfen Sie dieses Modell rekursiv, und geben Sie eine Liste von ValidationError zurück.

as_dict

Gibt ein Dict zurück, das mit json.dump JSONify sein kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameter

key_transformer

<xref:function>

Eine Schlüsseltransformatorfunktion.

keep_readonly

Standardwert: True

Gibt zurück

Ein JSON-kompatibles Diktatobjekt

Rückgabetyp

dict

deserialize

Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

deserialize(data, content_type=None)

Parameter

data

str

Erforderlich

Eine str-Struktur, die die RestAPI-Struktur verwendet. Standardmäßig JSON.

content_type

str

Standardwert: None

Json standardmäßig, legen Sie application/xml fest, wenn XML.

Gibt zurück

Eine instance dieses Modells

Ausnahmen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameter

data

dict

Erforderlich

Ein Diktat mithilfe der RestAPI-Struktur

content_type

str

Standardwert: None

Json standardmäßig, legen Sie application/xml fest, wenn XML.

key_extractors

Standardwert: None

Gibt zurück

Eine instance dieses Modells

Ausnahmen

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet wird.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

serialize(keep_readonly=False, **kwargs)

Parameter

keep_readonly

bool

Standardwert: False

Wenn Sie die schreibgeschützten Attribute serialisieren möchten

Gibt zurück

Ein JSON-kompatibles Diktatobjekt

Rückgabetyp

dict

validate

Überprüfen Sie dieses Modell rekursiv, und geben Sie eine Liste von ValidationError zurück.

validate()

Gibt zurück

Eine Liste mit Validierungsfehlern

Rückgabetyp

list