Twin Třída
Informace o stavu zařízení nebo modulu Tato identita se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.
- Dědičnost
-
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)Parametry
- device_id
- str
Jedinečný identifikátor zařízení v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) se 7bitovými alfanumerickými znaky ASCII. a následující speciální znaky {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
- module_id
- str
Jedinečný identifikátor modulu v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) se 7bitovými alfanumerickými znaky ASCII. a následující speciální znaky {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
Kolekce párů klíč-hodnota načítá a zapisuje back-end řešení. Aplikace zařízení je nevidí. Jejich klíče jsou zakódované UTF-8, rozlišují se malá a malá písmena a délkou až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON o délce až 4 kB.
- version
- <xref:long>
Verze dvojčete zařízení včetně značek a požadovaných vlastností
- status
- str nebo <xref:protocol.models.enum>
Stav povoleného zařízení. Pokud je tato možnost zakázaná, zařízení se nemůže připojit ke službě. Mezi možné hodnoty patří: "povoleno", "zakázáno".
- connection_state
- str nebo <xref:protocol.models.enum>
Stav připojení zařízení. Možné hodnoty: "Odpojeno", "Připojeno"
- last_activity_time
- datetime
Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu. Datum a čas jsou ve formátu data a času ISO8601 ve formátu UTC, například 28T16:24:48.789Z. Tato hodnota se neaktualizuje, pokud zařízení k provádění operací zasílání zpráv používá protokol HTTP/1.
- authentication_type
- str nebo <xref:protocol.models.enum>
Typ ověřování používaný zařízením. Mezi možné hodnoty patří sas, selfSigned, certificateAuthority, none.
- capabilities
- DeviceCapabilities
Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
Metody
| as_dict |
Vrátí dikt, který může být JSONify pomocí json.dump. Rozšířené využití může volitelně použít zpětné volání jako parametr: Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu. Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku. Podívejte se na tři příklady v tomto souboru:
Pokud chcete serializaci XML, můžete předat kwargs is_xml=True. |
| deserialize |
Parsujte str pomocí syntaxe RestAPI a vraťte model. |
| enable_additional_properties_sending | |
| from_dict |
Analýza diktu pomocí daného extraktoru klíčů vrátí model. Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor). |
| is_xml_model | |
| serialize |
Vrátí kód JSON, který se z tohoto modelu odešle do Azure. Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False). Pokud chcete serializaci XML, můžete předat kwargs is_xml=True. |
| validate |
Rekurzivně ověřte tento model a vraťte seznam ValidationError. |
as_dict
Vrátí dikt, který může být JSONify pomocí json.dump.
Rozšířené využití může volitelně použít zpětné volání jako parametr:
Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.
Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.
Podívejte se na tři příklady v tomto souboru:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)Parametry
- key_transformer
- <xref:function>
Funkce klíčového transformátoru.
- keep_readonly
Návraty
Objekt kompatibilní s diktem JSON
Návratový typ
deserialize
Parsujte str pomocí syntaxe RestAPI a vraťte model.
deserialize(data, content_type=None)Parametry
- content_type
- str
Ve výchozím nastavení JSON nastavte application/xml, pokud XML.
Návraty
Instance tohoto modelu
Výjimky
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
Analýza diktu pomocí daného extraktoru klíčů vrátí model.
Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
from_dict(data, key_extractors=None, content_type=None)Parametry
- content_type
- str
Ve výchozím nastavení JSON nastavte application/xml, pokud XML.
- key_extractors
Návraty
Instance tohoto modelu
Výjimky
is_xml_model
is_xml_model()serialize
Vrátí kód JSON, který se z tohoto modelu odešle do Azure.
Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).
Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)Parametry
Návraty
Objekt kompatibilní s diktem JSON
Návratový typ
validate
Rekurzivně ověřte tento model a vraťte seznam ValidationError.
validate()Návraty
Seznam chyb ověření
Návratový typ
Azure SDK for Python