Sdílet prostřednictvím

ExportImportDevice Třída

  • Reference

ExportImportDevice.

Dědičnost
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)

Parametry

id
str
Vyžadováno

Jedinečný identifikátor zařízení.

module_id
str
Vyžadováno

Jedinečný identifikátor modulu, pokud je k dispozici.

e_tag
str
Vyžadováno

Řetězec představující slabou ETag pro zařízení RFC7232. Hodnota se použije pouze v případě, že je režim importu updateIfMatchETag, v takovém případě se operace importu provede pouze v případě, že tato značka ETag odpovídá hodnotě udržované serverem.

import_mode
str nebo <xref:protocol.models.enum>
Vyžadováno

Typ operace registru a předvolby značky ETag. Mezi možné hodnoty patří: create, update, updateIfMatchETag, delete, deleteIfMatchETag, updateTwin, updateTwinIfMatchETag.

status
str nebo <xref:protocol.models.enum>
Vyžadováno

Stav modulu Pokud je tato možnost zakázaná, modul se nemůže připojit ke službě. Mezi možné hodnoty patří: "enabled", 'disabled'

status_reason
str
Vyžadováno

Řetězec dlouhý 128 znaků, ve kterém je uložen důvod stavu identity zařízení. Jsou povoleny všechny znaky UTF-8.

authentication
AuthenticationMechanism
Vyžadováno

Mechanismus ověřování používaný modulem Tento parametr je volitelný, a pokud není zadaný, ve výchozím nastavení používá SAS. V takovém případě se primární/sekundární přístupové klíče vygenerují automaticky.

twin_etag
str
Vyžadováno

Řetězec představující slabou ETag pro dvojčete zařízení RFC7232. Hodnota se použije pouze v případě, že je režim importu updateIfMatchETag, v takovém případě se operace importu provede pouze v případě, že tato značka ETag odpovídá hodnotě udržované serverem.

tags
dict[str, object]
Vyžadováno

Dokument JSON přečte a zapíše back-end řešení. Aplikace zařízení značky nevidí.

properties
PropertyContainer
Vyžadováno

Požadované a hlášené vlastnosti zařízení

capabilities
DeviceCapabilities
Vyžadováno

Stav funkcí povolených na zařízení.

device_scope
str
Vyžadováno

Rozsah zařízení.

parent_scopes
list[str]
Vyžadováno

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.

Metody

as_dict

Vrácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value 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 to 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.
deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict

Parsování diktování 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ácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value 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 to 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
výchozí hodnota: True

Návraty

Objekt kompatibilní se dict JSON

Návratový typ

dict

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data, content_type=None)

Parametry

data
str
Vyžadováno

Str využívající strukturu RestAPI. Json ve výchozím nastavení.

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Parsování diktování 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

data
dict
Vyžadováno

A dict using RestAPI structure

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

key_extractors
výchozí hodnota: None

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

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

keep_readonly
bool
výchozí hodnota: False

Pokud chcete serializovat atributy readonly

Návraty

Objekt kompatibilní se dict JSON

Návratový typ

dict

validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

validate()

Návraty

Seznam chyb ověření

Návratový typ

list