Compartilhar via

ExportImportDevice Classe

  • Referência

ExportImportDevice.

Herança
Model
ExportImportDevice

Construtor

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)

Parâmetros

id
str
Obrigatório

O identificador exclusivo do dispositivo.

module_id
str
Obrigatório

O identificador exclusivo do módulo, se aplicável.

e_tag
str
Obrigatório

A cadeia de caracteres que representa uma ETag fraca para o dispositivo RFC7232. O valor só será usado se o modo de importação for updateIfMatchETag, nesse caso, a operação de importação será executada somente se essa ETag corresponder ao valor mantido pelo servidor.

import_mode
str ou <xref:protocol.models.enum>
Obrigatório

O tipo de operação do Registro e as preferências de ETag. Os valores possíveis incluem: 'create', 'update', 'updateIfMatchETag', 'delete', 'deleteIfMatchETag', 'updateTwin', 'updateTwinIfMatchETag'

status
str ou <xref:protocol.models.enum>
Obrigatório

O status do módulo. Se desabilitado, o módulo não poderá se conectar ao serviço. Os valores possíveis incluem: 'enabled', 'disabled'

status_reason
str
Obrigatório

A cadeia de caracteres de 128 caracteres que armazena o motivo da identidade do dispositivo status. Todos os caracteres UTF-8 são permitidos.

authentication
AuthenticationMechanism
Obrigatório

O mecanismo de autenticação usado pelo módulo. Esse parâmetro é opcional e usa SAS como padrão se não for fornecido. Nesse caso, as chaves de acesso primárias/secundárias são geradas automaticamente.

twin_etag
str
Obrigatório

A cadeia de caracteres que representa uma ETag fraca para o dispositivo gêmeo RFC7232. O valor só será usado se o modo de importação for updateIfMatchETag, nesse caso, a operação de importação será executada somente se essa ETag corresponder ao valor mantido pelo servidor.

tags
dict[str, object]
Obrigatório

O documento JSON lido e gravado pelo back-end da solução. As marcas não são visíveis para aplicativos de dispositivo.

properties
PropertyContainer
Obrigatório

As propriedades desejadas e relatadas para o dispositivo.

capabilities
DeviceCapabilities
Obrigatório

O status de recursos habilitados no dispositivo.

device_scope
str
Obrigatório

O escopo do dispositivo.

parent_scopes
list[str]
Obrigatório

Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível somente para dispositivos de borda.

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