JobProperties Класс

Свойства задания.

Наследование

Model

JobProperties

Конструктор

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)

Параметры

job_id

str

Обязательно

Уникальный идентификатор задания.

start_time_utc

datetime

Обязательно

Создано системой. Игнорируется при создании. Дата и время начала задания в формате UTC.

end_time_utc

datetime

Обязательно

Создано системой. Игнорируется при создании. Дата и время окончания задания в формате UTC.

type

str или <xref:protocol.models.enum>

Обязательно

Тип задания. Возможные значения: "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate", "scheduleDeviceMethod", "scheduleUpdateTwin", "restoreFromBackup", "failoverDataCopy".

status

str или <xref:protocol.models.enum>

Обязательно

Создано системой. Игнорируется при создании. Состояние задания. Возможные значения: "unknown", "enqueued", "running", "completed", "failed", "cancelled", "scheduled", "queued"

progress

int

Обязательно

Создано системой. Игнорируется при создании. Процент завершения задания.

input_blob_container_uri

str

Обязательно

Универсальный код ресурса (URI), содержащий маркер SAS для контейнера больших двоичных объектов, содержащего данные реестра для синхронизации.

input_blob_name

str

Обязательно

Имя большого двоичного объекта, используемое при импорте из контейнера входных BLOB-объектов.

output_blob_container_uri

str

Обязательно

Маркер SAS для доступа к контейнеру BLOB-объектов. Используется для вывода состояния и результатов задания.

output_blob_name

str

Обязательно

Имя большого двоичного объекта, которое будет создано в контейнере выходных BLOB-объектов. Этот BLOB-объект будет содержать экспортированные сведения реестра устройств для Центр Интернета вещей.

exclude_keys_in_export

bool

Обязательно

Необязательно для заданий экспорта; игнорируется для других заданий. Если значение не указано, служба по умолчанию имеет значение false. Если значение равно false, ключи авторизации включаются в выходные данные экспорта. В противном случае ключи экспортируются как null.

storage_authentication_type

str или <xref:protocol.models.enum>

Обязательно

Тип проверки подлинности, используемый для подключения к учетной записи хранения. Возможные значения: "keyBased", "identityBased"

identity

ManagedIdentity

Обязательно

failure_reason

str

Обязательно

Система генеирована. Игнорируется при создании. Причина сбоя, если произошел сбой.

include_configurations

bool

Обязательно

Значение по умолчанию — false. Если задано значение true, конфигурации включаются в экспорт и импорт данных.

configurations_blob_name

str

Обязательно

По умолчанию configurations.txt. Указывает имя большого двоичного объекта, используемого при экспорте или импорте конфигураций.

Методы

as_dict	Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump. При дополнительном использовании можно использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Если требуется сериализация XML, можно передать kwargs is_xml=True.
deserialize	Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
enable_additional_properties_sending
from_dict	Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель. По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize	Возвращает json, который будет отправлен в Azure из этой модели. Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False). Если требуется сериализация XML, можно передать kwargs is_xml=True.
validate	Рекурсивная проверка модели и возврат списка ValidationError.

as_dict

Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump.

При дополнительном использовании можно использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Если требуется сериализация XML, можно передать kwargs is_xml=True.

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

Параметры

key_transformer

<xref:function>

Функция преобразователя ключей.

keep_readonly

значение по умолчанию: True

Возвращаемое значение

Объект, совместимый с JSON для диктовки

Возвращаемый тип

dict

deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.

deserialize(data, content_type=None)

Параметры

data

str

Обязательно

Str, использующий структуру RestAPI. JSON по умолчанию.

content_type

str

значение по умолчанию: None

JSON по умолчанию задайте значение application/xml, если XML.

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

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

Параметры

data

dict

Обязательно

Диктовка, использующий структуру RestAPI

content_type

str

значение по умолчанию: None

JSON по умолчанию задайте значение application/xml, если XML.

key_extractors

значение по умолчанию: None

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется сериализация XML, можно передать kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Параметры

keep_readonly

bool

значение по умолчанию: False

Если вы хотите сериализовать атрибуты только для чтения

Возвращаемое значение

Объект, совместимый с JSON для диктовки

Возвращаемый тип

dict

validate

Рекурсивная проверка модели и возврат списка ValidationError.

validate()

Возвращаемое значение

Список ошибок проверки

Возвращаемый тип

list