TaskOperations Класс

Операции TaskOperations.

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

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

builtins.object

TaskOperations

Конструктор

TaskOperations(client, config, serializer, deserializer)

Параметры

client

Обязательно

Клиент для запросов на обслуживание.

config

Обязательно

Настройка клиента службы.

serializer

Обязательно

Сериализатор объектной модели.

deserializer

Обязательно

Десериализатор объектной модели.

Переменные

api_version

Версия API для использования в запросе. Постоянное значение: "2023-05-01.17.0".

Методы

add	Добавляет задачу в указанное задание. Максимальное время существования задачи с момента добавления до завершения составляет 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет завершена пакетной службой и останется в любом состоянии, в которое она находилась на тот момент.
add_collection	Добавляет коллекцию задач в указанное задание. Обратите внимание, что каждая задача должна иметь уникальный идентификатор. Пакетная служба может не возвращать результаты для каждой задачи в том же порядке, в который были отправлены задачи в этом запросе. Если время ожидания сервера истекает или подключение закрывается во время запроса, возможно, запрос был частично или полностью обработан или не был вообще. В таких случаях пользователю следует повторно выдать запрос. Обратите внимание, что пользователь может правильно обрабатывать ошибки при повторной отправке запроса. Например, во время повторных попыток следует использовать одни и те же идентификаторы задач, чтобы при успешном выполнении предыдущей операции повторная попытка не приводила к неожиданному созданию дополнительных задач. Если ответ содержит какие-либо задачи, которые не удалось добавить, клиент может повторить запрос. При повторных попытках наиболее эффективно повторно отправить только те задачи, которые не удалось добавить, и опустить задачи, которые были успешно добавлены с первой попытки. Максимальное время существования задачи с момента добавления до завершения составляет 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет завершена пакетной службой и останется в любом состоянии, в которой она находилась на тот момент.
delete	Удаляет задачу из указанного задания. При удалении задачи все файлы в ее каталоге на вычислительном узле, где она запущена, также удаляются (независимо от времени хранения). Для задач с несколькими экземплярами операция удаления задачи применяется синхронно к основной задаче; Затем подзадачи и их файлы асинхронно удаляются в фоновом режиме.
get	Возвращает сведения об указанной задаче. Для задач с несколькими экземплярами такие сведения, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API подзадач списка для получения сведений о подзадачах.
list	Список всех задач, связанных с указанным заданием. Для задач с несколькими экземплярами такие сведения, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API подзадач списка для получения сведений о подзадачах.
list_subtasks	Список всех подзадач, связанных с указанной задачей с несколькими экземплярами. Если задача не является многоэкземной задачей, возвращается пустая коллекция.
reactivate	Повторно активирует задачу, позволяя ей выполняться снова, даже если ее число повторных попыток исчерпано. При повторной активации задача может быть повторно повторна до максимального числа повторных попыток. Состояние задачи изменяется на активное. Так как задача больше не находится в состоянии завершения, все предыдущие коды выхода или сведения о сбое больше не будут доступны после повторной активации. При каждой повторной активации задачи число повторных попыток сбрасывается до 0. Повторная активация завершится ошибкой для задач, которые не завершены или ранее успешно завершены (с кодом выхода 0). Кроме того, он завершится ошибкой, если задание завершено (или завершается или удаляется).
terminate	Завершает указанную задачу. После завершения задачи она переходит в состояние завершено. Для задач с несколькими экземплярами операция завершения задачи применяется синхронно к основной задаче; Затем подзадачи завершаются асинхронно в фоновом режиме.
update	Обновления свойства указанной задачи.

add

Добавляет задачу в указанное задание.

Максимальное время существования задачи с момента добавления до завершения составляет 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет завершена пакетной службой и останется в любом состоянии, в которое она находилась на тот момент.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, к которому добавляется задача.

task

TaskAddParameter

Обязательно

Добавляемая задача.

task_add_options

TaskAddOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

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

None,

ClientRawResponse

Исключения

BatchErrorException

add_collection

Добавляет коллекцию задач в указанное задание.

Обратите внимание, что каждая задача должна иметь уникальный идентификатор. Пакетная служба может не возвращать результаты для каждой задачи в том же порядке, в который были отправлены задачи в этом запросе. Если время ожидания сервера истекает или подключение закрывается во время запроса, возможно, запрос был частично или полностью обработан или не был вообще. В таких случаях пользователю следует повторно выдать запрос. Обратите внимание, что пользователь может правильно обрабатывать ошибки при повторной отправке запроса. Например, во время повторных попыток следует использовать одни и те же идентификаторы задач, чтобы при успешном выполнении предыдущей операции повторная попытка не приводила к неожиданному созданию дополнительных задач. Если ответ содержит какие-либо задачи, которые не удалось добавить, клиент может повторить запрос. При повторных попытках наиболее эффективно повторно отправить только те задачи, которые не удалось добавить, и опустить задачи, которые были успешно добавлены с первой попытки. Максимальное время существования задачи с момента добавления до завершения составляет 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет завершена пакетной службой и останется в любом состоянии, в которой она находилась на тот момент.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, к которому добавляется коллекция задач.

value

list of TaskAddParameter

Обязательно

Коллекция добавляемых задач. Общий сериализованный размер этой коллекции должен быть меньше 4 МБ. Если значение превышает 4 МБ (например, если каждая задача содержит 100 файлов ресурсов или переменных среды), запрос завершится ошибкой с кодом RequestBodyTooLarge и будет повторен с меньшим количеством задач.

task_add_collection_options

TaskAddCollectionOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

threads

int

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

количество потоков для параллельного использования при добавлении задач. Если задано значение и больше 0, будет запускать дополнительные потоки для отправки запросов и ожидать их завершения. В противном случае запросы add_collection будут отправляться последовательно в потоке main

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

TaskAddCollectionResult или ClientRawResponse , если raw=true

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

TaskAddCollectionResult,

ClientRawResponse

Исключения

azure.batch.custom.CreateTasksErrorException

delete

Удаляет задачу из указанного задания.

При удалении задачи все файлы в ее каталоге на вычислительном узле, где она запущена, также удаляются (независимо от времени хранения). Для задач с несколькими экземплярами операция удаления задачи применяется синхронно к основной задаче; Затем подзадачи и их файлы асинхронно удаляются в фоновом режиме.

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, из которого удаляется задача.

task_id

str

Обязательно

Идентификатор удаляемой задачи.

task_delete_options

TaskDeleteOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

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

None,

ClientRawResponse

Исключения

BatchErrorException

get

Возвращает сведения об указанной задаче.

Для задач с несколькими экземплярами такие сведения, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API подзадач списка для получения сведений о подзадачах.

get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, содержащего задачу.

task_id

str

Обязательно

Идентификатор задачи для получения сведений.

task_get_options

TaskGetOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

CloudTask или ClientRawResponse, если raw=true

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

CloudTask,

ClientRawResponse

Исключения

BatchErrorException

list

Список всех задач, связанных с указанным заданием.

Для задач с несколькими экземплярами такие сведения, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API подзадач списка для получения сведений о подзадачах.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания.

task_list_options

TaskListOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

Итератор, например экземпляр CloudTask

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

CloudTaskPaged[CloudTask]

Исключения

BatchErrorException

list_subtasks

Список всех подзадач, связанных с указанной задачей с несколькими экземплярами.

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

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания.

task_id

str

Обязательно

Идентификатор задачи.

task_list_subtasks_options

TaskListSubtasksOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

CloudTaskListSubtasksResult или ClientRawResponse, если raw=true

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

CloudTaskListSubtasksResult,

ClientRawResponse

Исключения

BatchErrorException

reactivate

Повторно активирует задачу, позволяя ей выполняться снова, даже если ее число повторных попыток исчерпано.

При повторной активации задача может быть повторно повторна до максимального числа повторных попыток. Состояние задачи изменяется на активное. Так как задача больше не находится в состоянии завершения, все предыдущие коды выхода или сведения о сбое больше не будут доступны после повторной активации. При каждой повторной активации задачи число повторных попыток сбрасывается до 0. Повторная активация завершится ошибкой для задач, которые не завершены или ранее успешно завершены (с кодом выхода 0). Кроме того, он завершится ошибкой, если задание завершено (или завершается или удаляется).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, содержащего задачу.

task_id

str

Обязательно

Идентификатор задачи для повторной активации.

task_reactivate_options

TaskReactivateOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

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

None,

ClientRawResponse

Исключения

BatchErrorException

terminate

Завершает указанную задачу.

После завершения задачи она переходит в состояние завершено. Для задач с несколькими экземплярами операция завершения задачи применяется синхронно к основной задаче; Затем подзадачи завершаются асинхронно в фоновом режиме.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, содержащего задачу.

task_id

str

Обязательно

Идентификатор завершаемой задачи.

task_terminate_options

TaskTerminateOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

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

None,

ClientRawResponse

Исключения

BatchErrorException

update

Обновления свойства указанной задачи.

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, содержащего задачу.

task_id

str

Обязательно

Идентификатор обновляемой задачи.

constraints

TaskConstraints

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

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

task_update_options

TaskUpdateOptions

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

Дополнительные параметры для операции

custom_headers

dict

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

заголовки, которые будут добавлены в запрос

raw

bool

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

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

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

None,

ClientRawResponse

Исключения

BatchErrorException

Атрибуты

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>