Module Klasa

Tożsamość modułu na urządzeniu.

Dziedziczenie

Model

Module

Konstruktor

Module(*, module_id: str = None, managed_by: str = None, device_id: str = None, generation_id: str = None, etag: str = None, connection_state=None, connection_state_updated_time=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication=None, **kwargs)

Parametry

module_id

str

Wymagane

Unikatowy identyfikator modułu.

managed_by

str

Wymagane

Określa, kto zarządza tym modułem. Na przykład ta wartość to "IotEdge", jeśli środowisko uruchomieniowe krawędzi jest właścicielem tego modułu.

device_id

str

Wymagane

Unikatowy identyfikator urządzenia.

generation_id

str

Wymagane

Wygenerowany IoT Hub ciąg z uwzględnieniem wielkości liter do 128 znaków. Ta wartość służy do rozróżniania modułów o tym samym identyfikatorze moduleId, gdy zostały usunięte i ponownie utworzone.

etag

str

Wymagane

Ciąg reprezentujący słaby element ETag dla tożsamości modułu zgodnie z specyfikacją RFC7232.

connection_state

str lub <xref:protocol.models.enum>

Wymagane

Stan połączenia urządzenia. Możliwe wartości to: "Rozłączone", "Połączone"

connection_state_updated_time

datetime

Wymagane

Data i godzina ostatniej aktualizacji stanu połączenia.

last_activity_time

datetime

Wymagane

Data i godzina ostatniego połączenia, odebrania lub wysłania wiadomości przez urządzenie.

cloud_to_device_message_count

int

Wymagane

Liczba komunikatów z chmury do modułu, które mają być obecnie wysyłane do modułu.

authentication

AuthenticationMechanism

Wymagane

Mechanizm uwierzytelniania używany przez moduł podczas nawiązywania połączenia z usługą i koncentratorem brzegowym.

Metody

as_dict	Zwróć dykt, który może być JSONify przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku. Zobacz trzy przykłady w tym pliku: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize	Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict	Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model. Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu. Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
validate	Zweryfikuj ten model cyklicznie i zwróć listę wartości ValidationError.

as_dict

Zwróć dykt, który może być JSONify przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku.

Zobacz trzy przykłady w tym pliku:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametry

key_transformer

<xref:function>

Funkcja przekształcania klucza.

keep_readonly

wartość domyślna: True

Zwraca

Obiekt zgodny z JSON w formacie JSON

Typ zwracany

dict

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

deserialize(data, content_type=None)

Parametry

data

str

Wymagane

Str używający struktury RestAPI. Domyślnie kod JSON.

content_type

str

wartość domyślna: None

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

Zwraca

Wystąpienie tego modelu

Wyjątki

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model.

Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parametry

data

dict

Wymagane

Dykt używający struktury RESTAPI

content_type

str

wartość domyślna: None

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

key_extractors

wartość domyślna: None

Zwraca

Wystąpienie tego modelu

Wyjątki

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu.

Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

keep_readonly

bool

wartość domyślna: False

Jeśli chcesz serializować atrybuty readonly

Zwraca

Obiekt zgodny z JSON w formacie JSON

Typ zwracany

dict

validate

Zweryfikuj ten model cyklicznie i zwróć listę wartości ValidationError.

validate()

Zwraca

Lista błędów weryfikacji

Typ zwracany

list