JobProperties Classe
JobProperties.
- Herança
-
JobProperties
Construtor
JobProperties(**kwargs)
Parâmetros
- start_time_utc
- datetime
Sistema gerado. Ignorado na criação. A data e a hora de início do trabalho em UTC.
- end_time_utc
- datetime
Sistema gerado. Ignorado na criação. A data e a hora de término do trabalho em UTC.
- type
- str ou <xref:protocol.models.enum>
O tipo de trabalho. Os valores possíveis incluem: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate', 'scheduleDeviceMethod', 'scheduleUpdateTwin', 'restoreFromBackup', 'failoverDataCopy'
- status
- str ou <xref:protocol.models.enum>
Sistema gerado. Ignorado na criação. O status do trabalho. Os valores possíveis incluem: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'enfileirado'
- progress
- int
Sistema gerado. Ignorado na criação. O percentual de conclusão do trabalho.
- input_blob_container_uri
- str
O URI que contém o token SAS para um contêiner de blob que contém dados do Registro a serem sincronizados.
- input_blob_name
- str
O nome do blob a ser usado ao importar do contêiner de blob de entrada.
- output_blob_container_uri
- str
O token SAS para acessar o contêiner de blob. Isso é usado para gerar o status e os resultados do trabalho.
- output_blob_name
- str
O nome do blob que será criado no contêiner de blob de saída. Esse blob conterá as informações do registro de dispositivo exportado para o Hub IoT.
- exclude_keys_in_export
- bool
Opcional para trabalhos de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço usará como padrão false. Se for false, as chaves de autorização serão incluídas na saída de exportação. As chaves serão exportadas como nulas caso contrário.
- storage_authentication_type
- str ou <xref:protocol.models.enum>
O tipo de autenticação usado para se conectar à conta de armazenamento. Os valores possíveis incluem: 'keyBased', 'identityBased'
- identity
- ManagedIdentity
- failure_reason
- str
Sistema genereado. Ignorado na criação. O motivo da falha, se ocorreu uma falha.
- include_configurations
- bool
O padrão é false. Se for true, as configurações serão incluídas na exportação/importação de dados.
- configurations_blob_name
- str
O padrão é configurations.txt. Especifica o nome do blob a ser usado ao exportar/importar configurações.
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:
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
Retornos
Um objeto compatível com JSON de dict
Tipo de retorno
deserialize
Analise um str usando a sintaxe RestAPI e retorne um modelo.
deserialize(data, content_type=None)
Parâmetros
Retornos
Uma instância desse modelo
Exceções
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
- key_extractors
Retornos
Uma instância desse modelo
Exceções
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
Retornos
Um objeto compatível com JSON de dict
Tipo de retorno
validate
Valide esse modelo recursivamente e retorne uma lista de ValidationError.
validate()
Retornos
Uma lista de erros de validação
Tipo de retorno
Azure SDK for Python