ExportImportDevice Klasse
ExportImportDevice.
- Vererbung
-
ExportImportDevice
Konstruktor
ExportImportDevice(*, id: str = None, module_id: str = None, e_tag: str = None, import_mode=None, status=None, status_reason: str = None, authentication=None, twin_etag: str = None, tags=None, properties=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)Parameter
- e_tag
- str
Die Zeichenfolge, die ein schwaches ETag für das Gerät RFC7232 darstellt. Der Wert wird nur verwendet, wenn der Importmodus updateIfMatchETag ist. In diesem Fall wird der Importvorgang nur ausgeführt, wenn dieser ETag mit dem vom Server verwalteten Wert übereinstimmt.
- import_mode
- str oder <xref:protocol.models.enum>
Der Typ des Registrierungsvorgangs und die ETag-Einstellungen. Mögliche Werte: "create", "update", "updateIfMatchETag", "delete", "deleteIfMatchETag", "updateTwin", "updateTwin", "updateTwinIfMatchETag"
- status
- str oder <xref:protocol.models.enum>
Die status des Moduls. Wenn es deaktiviert ist, kann das Modul keine Verbindung mit dem Dienst herstellen. Mögliche Werte: "aktiviert", "deaktiviert"
- status_reason
- str
Die 128 Zeichen lange Zeichenfolge, die den Grund für die Geräteidentität status speichert. Alle UTF-8-Zeichen sind zulässig.
- authentication
- AuthenticationMechanism
Der vom Modul verwendete Authentifizierungsmechanismus. Dieser Parameter ist optional und wird standardmäßig auf SAS festgelegt, falls nicht angegeben. In diesem Fall werden primäre/sekundäre Zugriffsschlüssel automatisch generiert.
- twin_etag
- str
Die Zeichenfolge, die ein schwaches ETag für den Gerätezwilligen RFC7232 darstellt. Der Wert wird nur verwendet, wenn der Importmodus updateIfMatchETag ist. In diesem Fall wird der Importvorgang nur ausgeführt, wenn dieser ETag mit dem vom Server verwalteten Wert übereinstimmt.
Das JSON-Dokument, das vom Lösungs-Back-End gelesen und geschrieben wird. Die Tags sind für Geräte-Apps nicht sichtbar.
- properties
- PropertyContainer
Die gewünschten und gemeldeten Eigenschaften für das Gerät.
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 Dict 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 hierarchisches Ergebnisdikt betrachtet. Sehen Sie sich die drei Beispiele in dieser Datei an:
Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben. |
| deserialize |
Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück. |
| enable_additional_properties_sending | |
| from_dict |
Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück. Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt. |
| is_xml_model | |
| serialize |
Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde. Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False). Wenn Sie die 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 Dict 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 hierarchisches Ergebnisdikt betrachtet.
Sehen Sie sich die drei Beispiele in dieser Datei an:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Wenn Sie die 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üsseltransformerfunktion.
- keep_readonly
Gibt zurück
Ein JSON-kompatibles Objekt mit Dict
Rückgabetyp
deserialize
Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
deserialize(data, content_type=None)Parameter
Gibt zurück
Ein instance dieses Modells
Ausnahmen
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.
Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.
from_dict(data, key_extractors=None, content_type=None)Parameter
- key_extractors
Gibt zurück
Ein instance dieses Modells
Ausnahmen
is_xml_model
is_xml_model()serialize
Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde.
Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).
Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
serialize(keep_readonly=False, **kwargs)Parameter
- keep_readonly
- bool
Wenn Sie die schreibgeschützten Attribute serialisieren möchten
Gibt zurück
Ein JSON-kompatibles Objekt mit Dict
Rückgabetyp
validate
Überprüfen Sie dieses Modell rekursiv, und geben Sie eine Liste von ValidationError zurück.
validate()Gibt zurück
Eine Liste von Überprüfungsfehlern
Rückgabetyp
Azure SDK for Python