Configuration Classe

A configuração do dispositivo hub Iot e dos módulos gêmeos.

Herança

Model

Configuration

Construtor

Configuration(**kwargs)

Parâmetros

id

str

Obrigatório

O identificador exclusivo da configuração.

schema_version

str

Obrigatório

A versão do esquema da configuração.

labels

dict[str, str]

Obrigatório

Os pares chave-valor usados para descrever a configuração.

content

ConfigurationContent

Obrigatório

O conteúdo da configuração.

target_condition

str

Obrigatório

A consulta usada para definir os dispositivos ou módulos de destino. A consulta é baseada em marcas gêmeas e/ou propriedades relatadas.

created_time_utc

datetime

Obrigatório

A data e a hora de criação da configuração.

last_updated_time_utc

datetime

Obrigatório

A data e a hora da atualização da configuração.

priority

int

Obrigatório

O número de prioridade atribuído à configuração.

system_metrics

ConfigurationMetrics

Obrigatório

As métricas do sistema calculadas pelo Hub IoT que não podem ser personalizadas.

metrics

ConfigurationMetrics

Obrigatório

As métricas personalizadas especificadas pelo desenvolvedor como consultas em relação às propriedades relatadas do gêmeo.

etag

str

Obrigatório

A ETag da configuração.

Métodos

as_dict	Retornar um ditado que pode ser JSONify usando json.dump. Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro: Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto . A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico. Confira os três exemplos neste arquivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize	Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado usando determinado extrator de chave retorna um modelo. Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retorne o JSON que seria enviado para o azure desse modelo. Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
validate	Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

key_transformer

<xref:function>

Uma função de transformador de chave.

keep_readonly

valor padrão: True

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type

str

valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parâmetros

data

dict

Obrigatório

Um ditado usando a estrutura RestAPI

content_type

str

valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors

valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno

list