JobProperties Classe

JobProperties.

Herança

Model

JobProperties

Construtor

JobProperties(*, job_id: str = None, start_time_utc=None, end_time_utc=None, type=None, status=None, progress: int = None, input_blob_container_uri: str = None, input_blob_name: str = None, output_blob_container_uri: str = None, output_blob_name: str = None, exclude_keys_in_export: bool = None, storage_authentication_type=None, identity=None, failure_reason: str = None, include_configurations: bool = None, configurations_blob_name: str = None, **kwargs)

Parâmetros

job_id

str

Necessário

O identificador exclusivo da tarefa.

start_time_utc

datetime

Necessário

Sistema gerado. Ignorado na criação. A data e hora de início da tarefa em UTC.

end_time_utc

datetime

Necessário

Sistema gerado. Ignorado na criação. A data e hora de fim da tarefa em UTC.

type

str ou <xref:protocol.models.enum>

Necessário

O tipo de tarefa. Os valores possíveis incluem: "desconhecido", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy"

status

str ou <xref:protocol.models.enum>

Necessário

Sistema gerado. Ignorado na criação. O estado da tarefa. Os valores possíveis incluem: "desconhecido", "enqueued", "em execução", "concluído", "falhado", "cancelado", "agendado", "em fila"

progress

int

Necessário

Sistema gerado. Ignorado na criação. A percentagem de conclusão da tarefa.

input_blob_container_uri

str

Necessário

O URI que contém o token SAS para um contentor de blobs que contém dados de registo a sincronizar.

input_blob_name

str

Necessário

O nome do blob a utilizar ao importar do contentor de blobs de entrada.

output_blob_container_uri

str

Necessário

O token de SAS para aceder ao contentor de blobs. Isto é utilizado para produzir o estado e os resultados da tarefa.

output_blob_name

str

Necessário

O nome do blob que será criado no contentor de blobs de saída. Este blob irá conter as informações de registo de dispositivos exportadas para o Hub IoT.

exclude_keys_in_export

bool

Necessário

Opcional para tarefas de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço é predefinido como falso. Se for falso, as chaves de autorização são incluídas na saída de exportação. As chaves são exportadas como nulas, caso contrário.

storage_authentication_type

str ou <xref:protocol.models.enum>

Necessário

O tipo de autenticação utilizado para ligar à conta de armazenamento. Os valores possíveis incluem: "keyBased", "identityBased"

identity

ManagedIdentity

Necessário

failure_reason

str

Necessário

Sistema genereado. Ignorado na criação. O motivo da falha, se tiver ocorrido uma falha.

include_configurations

bool

Necessário

O valor predefinido é falso. Se for verdadeiro, as configurações são incluídas na exportação/importação de dados.

configurations_blob_name

str

Necessário

A predefinição é configurations.txt. Especifica o nome do blob a utilizar ao exportar/importar configurações.

Métodos

as_dict	Devolva um ditado que pode ser JSONify com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode passar os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devolva o JSON que seria enviado para o azure a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode passar os kwargs is_xml=True.
validate	Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolva um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode 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 chaves.

keep_readonly

valor predefinido: True

Devoluções

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Necessário

Um str com a estrutura RestAPI. JSON por predefinição.

content_type

str

valor predefinido: None

JSON por predefinição, defina aplicação/xml se XML.

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores 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

Necessário

Um ditado com a estrutura restAPI

content_type

str

valor predefinido: None

JSON por predefinição, defina aplicação/xml se XML.

key_extractors

valor predefinido: None

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devolva o JSON que seria enviado para o azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor predefinido: False

Se quiser serializar os atributos só de leitura

Devoluções

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

validate()

Devoluções

Uma lista de erros de validação

Tipo de retorno

list