Twin Osztály
Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik a IoT Hub.
- Öröklődés
-
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)
Paraméterek
- device_id
- str
Az eszköz egyedi azonosítója a IoT Hub identitásjegyzékében. Ez egy kis- és nagybetűket megkülönböztető sztring (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
- module_id
- str
A modul egyedi azonosítója a IoT Hub identitásjegyzékében. Ez egy kis- és nagybetűket megkülönböztető sztring (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
Kulcs-érték párok gyűjteménye, amelyeket a megoldás háttérrendszere olvas és ír. Nem láthatók az eszközalkalmazások számára. Ezek a kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. Az értékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.
- version
- <xref:long>
Az ikereszköz verziója címkékkel és kívánt tulajdonságokkal
- status
- str vagy <xref:protocol.models.enum>
Az eszköz engedélyezett állapota. Ha le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz. Lehetséges értékek: "enabled", "disabled"
- status_update_time
- datetime
Az eszköz állapotának utolsó frissítésének dátuma és időpontja.
- connection_state
- str vagy <xref:protocol.models.enum>
Az eszköz kapcsolati állapota. Lehetséges értékek: "Leválasztva", "Csatlakoztatva"
- last_activity_time
- datetime
Az a dátum és idő, amikor az eszköz utoljára csatlakozik, fogadott vagy üzenetet küldött. A dátum és az idő ISO8601 dátum/idő formátumban van megadva UTC formátumban, például 2015-01-28T16:24:48.789Z. Ez az érték nem frissül, ha az eszköz a HTTP/1 protokollt használja az üzenetkezelési műveletek végrehajtásához.
- authentication_type
- str vagy <xref:protocol.models.enum>
Az eszköz által használt hitelesítési típus. Lehetséges értékek: "sas", "selfSigned", "certificateAuthority", "none"
- capabilities
- DeviceCapabilities
A felső szintű peremeszközök hatókörei, ha vannak. Csak peremeszközökhöz érhető el.
Metódusok
as_dict |
A json.dump használatával JSONify formátumú diktált értéket ad vissza. A speciális használat opcionálisan visszahívást is használhat paraméterként: A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke. A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül. Tekintse meg a fájl három példáját:
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
deserialize |
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt. |
enable_additional_properties_sending | |
from_dict |
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza. Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Adja vissza a modellből az Azure-ba küldendő JSON-t. Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa. Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja. |
validate |
Ellenőrizze ezt a modellt rekurzív módon, és adja vissza a ValidationError listáját. |
as_dict
A json.dump használatával JSONify formátumú diktált értéket ad vissza.
A speciális használat opcionálisan visszahívást is használhat paraméterként:
A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke.
A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül.
Tekintse meg a fájl három példáját:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Paraméterek
- key_transformer
- <xref:function>
Egy kulcsátalakító függvény.
- keep_readonly
Válaszok
Diktátum JSON-kompatibilis objektum
Visszatérési típus
deserialize
Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.
deserialize(data, content_type=None)
Paraméterek
- content_type
- str
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML.
Válaszok
A modell egy példánya
Kivételek
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza.
Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Paraméterek
- content_type
- str
JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML.
- key_extractors
Válaszok
A modell egy példánya
Kivételek
is_xml_model
is_xml_model()
serialize
Adja vissza a modellből az Azure-ba küldendő JSON-t.
Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa.
Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
serialize(keep_readonly=False, **kwargs)
Paraméterek
- keep_readonly
- bool
Ha szerializálni szeretné az olvasható attribútumokat
Válaszok
Diktátum JSON-kompatibilis objektum
Visszatérési típus
validate
Ellenőrizze ezt a modellt rekurzív módon, és adja vissza a ValidationError listáját.
validate()
Válaszok
Az érvényesítési hiba listája
Visszatérési típus
Azure SDK for Python