Configuration Klasa

Konfiguracja bliźniaczych reprezentacji urządzeń i modułów usługi Iot Hub.

Dziedziczenie

Model

Configuration

Konstruktor

Configuration(*, id: str = None, schema_version: str = None, labels=None, content=None, target_condition: str = None, created_time_utc=None, last_updated_time_utc=None, priority: int = None, system_metrics=None, metrics=None, etag: str = None, **kwargs)

Parametry

id

str

Wymagane

Unikatowy identyfikator konfiguracji.

schema_version

str

Wymagane

Wersja schematu konfiguracji.

labels

dict[str, str]

Wymagane

Pary klucz-wartość używane do opisywania konfiguracji.

content

ConfigurationContent

Wymagane

Zawartość konfiguracji.

target_condition

str

Wymagane

Zapytanie używane do definiowania docelowych urządzeń lub modułów. Zapytanie jest oparte na tagach bliźniaczych i/lub zgłoszonych właściwościach.

created_time_utc

datetime

Wymagane

Data i godzina utworzenia konfiguracji.

last_updated_time_utc

datetime

Wymagane

Data i godzina aktualizacji konfiguracji.

priority

int

Wymagane

Numer priorytetu przypisany do konfiguracji.

system_metrics

ConfigurationMetrics

Wymagane

Metryki systemowe obliczane przez IoT Hub, których nie można dostosować.

metrics

ConfigurationMetrics

Wymagane

Metryki niestandardowe określone przez dewelopera jako zapytania dotyczące zgłoszonych właściwości bliźniaczej reprezentacji.

etag

str

Wymagane

Element ETag konfiguracji.

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