ExportImportDevice Osztály

ExportImportDevice.

Öröklődés

Model

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)

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

module_id

str

Kötelező

A modul egyedi azonosítója, ha van.

e_tag

str

Kötelező

Az RFC7232 eszköz gyenge ETag-jének megfelelő sztring. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel.

import_mode

str vagy <xref:protocol.models.enum>

Kötelező

A beállításjegyzék-művelet típusa és az ETag beállításai. Lehetséges értékek: "create", "update", "updateIfMatchETag", "delete", "deleteIfMatchETag", "updateTwin", "updateTwinIfMatchETag"

status

str vagy <xref:protocol.models.enum>

Kötelező

A modul állapota. Ha le van tiltva, a modul 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.

authentication

AuthenticationMechanism

Kötelező

A modul által használt hitelesítési mechanizmus. Ez a paraméter nem kötelező, és ha nincs megadva az SAS alapértelmezett értéke. Ebben az esetben az elsődleges/másodlagos hozzáférési kulcsok automatikusan jönnek létre.

twin_etag

str

Kötelező

Az Ikereszköz RFC7232 gyenge ETag-jének megfelelő sztring. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel.

tags

dict[str, object]

Kötelező

A megoldás háttérrendszere által olvasott és írt JSON-dokumentum. A címkék nem láthatók az eszközalkalmazások számára.

properties

PropertyContainer

Kötelező

Az eszköz kívánt és jelentett tulajdonságai.

capabilities

DeviceCapabilities

Kötelező

Az eszközön engedélyezett képességek állapota.

device_scope

str

Kötelező

Az eszköz hatóköre.

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