Device Osztály

Eszköz.

Öröklődés

Model

Device

Konstruktor

Device(*, device_id: str = None, generation_id: str = None, etag: str = None, connection_state=None, status=None, status_reason: str = None, connection_state_updated_time=None, status_updated_time=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

Paraméterek

device_id

str

Kötelező

Az eszköz egyedi azonosítója.

generation_id

str

Kötelező

A IoT Hub által létrehozott, legfeljebb 128 karakter hosszú kis- és nagybetűkre érzékeny sztring. Ez az érték az azonos deviceId azonosítójú eszközök megkülönböztetésére szolgál, amikor törölték és újra létrehozták őket.

etag

str

Kötelező

Az eszközidentitás gyenge ETag-jének sztringje az RFC7232 szerint.

connection_state

str vagy <xref:protocol.models.enum>

Kötelező

Az eszköz állapota. Lehetséges értékek: "Leválasztva", "Csatlakoztatva"

status

str vagy <xref:protocol.models.enum>

Kötelező

Az eszköz állapota. Ha az állapot le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz. Lehetséges értékek: "enabled", "disabled"

status_reason

str

Kötelező

Az eszközidentitás állapotának okát tároló 128 karakter hosszúságú sztring. Minden UTF-8 karakter megengedett.

connection_state_updated_time

datetime

Kötelező

A kapcsolati állapot legutóbbi frissítésének dátuma és időpontja.

status_updated_time

datetime

Kötelező

Az állapotmező utolsó frissítésének dátuma és időpontja.

last_activity_time

datetime

Kötelező

Az eszköz legutóbbi csatlakoztatásának, fogadásának vagy üzenetküldésének dátuma és utolsó időpontja.

cloud_to_device_message_count

int

Kötelező

Az eszközre küldendő, jelenleg várólistán lévő felhőből eszközre irányuló üzenetek száma.

authentication

AuthenticationMechanism

Kötelező

Az eszköz által használt hitelesítési mechanizmus.

capabilities

DeviceCapabilities

Kötelező

Az eszköz képességeinek halmaza. Ha például ez az eszköz egy peremeszköz, vagy sem.

device_scope

str

Kötelező

Az eszköz hatóköre. Automatikusan létrehozott és nem módosítható peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához.

parent_scopes

list[str]

Kötelező

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: 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.
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

alapértelmezett érték: True

Válaszok

Diktátum JSON-kompatibilis objektum

Visszatérési típus

dict

deserialize

Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.

deserialize(data, content_type=None)

Paraméterek

data

str

Kötelező

RestAPI-struktúrát használó struktúra. JSON alapértelmezés szerint.

content_type

str

alapértelmezett érték: None

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

DeserializationError if something went wrong

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

data

dict

Kötelező

Egy restAPI-struktúrát használó diktálás

content_type

str

alapértelmezett érték: None

JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML.

key_extractors

alapértelmezett érték: None

Válaszok

A modell egy példánya

Kivételek

DeserializationError if something went wrong

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

alapértelmezett érték: False

Ha szerializálni szeretné az olvasható attribútumokat

Válaszok

Diktátum JSON-kompatibilis objektum

Visszatérési típus

dict

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

list