JobOperations Класс

Операции JobOperations.

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

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

builtins.object

JobOperations

Конструктор

JobOperations(client, config, serializer, deserializer)

Параметры

client

Обязательно

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

config

Обязательно

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

serializer

Обязательно

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

deserializer

Обязательно

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

Переменные

api_version

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

Методы

add	Добавляет задание в указанную учетную запись. Пакетная служба поддерживает два способа управления работой, выполняемой в рамках задания. При первом подходе пользователь указывает задачу диспетчера заданий. Пакетная служба запускает эту задачу, когда она будет готова к запуску задания. Задача диспетчера заданий управляет всеми остальными задачами, выполняемыми в рамках этого задания, с помощью API задач. Во втором подходе пользователь напрямую управляет выполнением задач в активном задании с помощью API задач. Также обратите внимание: при именовании заданий не включайте конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эти сведения могут отображаться в журналах телеметрии, доступных инженерам службы поддержки Майкрософт.
delete	Удаляет задание. При удалении задания также удаляются все задачи, которые являются частью этого задания, и все статистические данные заданий. Это также переопределяет период хранения для данных задачи; То есть, если задание содержит задачи, которые по-прежнему хранятся на вычислительных узлах, пакетные службы удаляют рабочие каталоги этих задач и все их содержимое. При получении запроса на удаление задания пакетная служба устанавливает для задания состояние удаления. Все операции обновления в задании, которое находится в состоянии удаления, завершатся сбоем с кодом состояния 409 (конфликт) и дополнительными сведениями о том, что задание удаляется.
disable	Отключает указанное задание, предотвращая выполнение новых задач. Пакетная служба немедленно переместит задание в состояние отключения. Затем пакетная служба использует параметр disableTasks, чтобы определить, что делать с текущими задачами задания. Задание остается в состоянии отключения, пока операция отключения не будет завершена и все задачи не будут обработаны в соответствии с параметром disableTasks; Затем задание переходит в отключенное состояние. Новые задачи не запускаются в задании, пока оно не перейдет в активное состояние. При попытке отключить задание, которое находится в состоянии, отличном от активного, отключенного или отключенного, запрос завершается ошибкой с кодом состояния 409.
enable	Включает указанное задание, позволяя выполнять новые задачи. При вызове этого API пакетная служба устанавливает для отключенного задания состояние включения. После завершения этой операции задание переходит в активное состояние, а планирование новых задач в задании возобновляется. Пакетная служба не позволяет задаче оставаться в активном состоянии более 180 дней. Таким образом, если включить задание, содержащее активные задачи, которые были добавлены более 180 дней назад, эти задачи не будут выполняться.
get	Возвращает сведения об указанном задании.
get_task_counts	Возвращает количество задач для указанного задания. Количество задач предоставляет количество задач по активному, запущенным или завершенным состоянию задачи, а также количество успешных или неудачных задач. Задачи в состоянии подготовки считаются запущенными. Обратите внимание, что возвращаемые числа не всегда могут быть актуальными. Если требуется точное количество задач, используйте запрос списка.
list	Выводит список всех заданий в указанной учетной записи.
list_from_job_schedule	Список заданий, созданных в соответствии с указанным расписанием заданий.
list_preparation_and_release_task_status	Перечисляет состояние выполнения задачи подготовки задания и выпуска задания для указанного задания на вычислительных узлах, на которых выполняется задание. Этот API возвращает состояние задачи подготовки задания и выпуска задания на всех вычислительных узлах, на которых запущена задача подготовки задания или выпуска задания. Сюда входят вычислительные узлы, которые были удалены из пула. Если этот API вызывается в задании, которое не имеет задачи подготовки задания или выпуска задания, пакетная служба возвращает код состояния HTTP 409 (конфликт) с кодом ошибки JobPreparationTaskNotSpecified.
patch	Обновления свойства указанного задания. Это заменяет только свойства задания, указанные в запросе. Например, если задание имеет ограничения, а в запросе не указан элемент ограничений, то задание сохраняет существующие ограничения.
terminate	Завершает указанное задание, помечая его как завершенное. При получении запроса на завершение задания пакетная служба присваивает заданию завершающееся состояние. Пакетная служба завершает все выполняемые задачи, связанные с заданием, и запускает все необходимые задачи выпуска задания. Затем задание переходит в состояние завершено. Если в задании есть какие-либо задачи в активном состоянии, они останутся в активном состоянии. После завершения задания новые задачи нельзя добавить, а оставшиеся активные задачи не будут планироваться.
update	Обновления свойства указанного задания. Это полностью заменяет все обновляемые свойства задания. Например, если задание имеет связанные с ним ограничения и если ограничения не указаны в этом запросе, пакетная служба удалит существующие ограничения.

add

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

Пакетная служба поддерживает два способа управления работой, выполняемой в рамках задания. При первом подходе пользователь указывает задачу диспетчера заданий. Пакетная служба запускает эту задачу, когда она будет готова к запуску задания. Задача диспетчера заданий управляет всеми остальными задачами, выполняемыми в рамках этого задания, с помощью API задач. Во втором подходе пользователь напрямую управляет выполнением задач в активном задании с помощью API задач. Также обратите внимание: при именовании заданий не включайте конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эти сведения могут отображаться в журналах телеметрии, доступных инженерам службы поддержки Майкрософт.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job

JobAddParameter

Обязательно

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

job_add_options

JobAddOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

delete

Удаляет задание.

При удалении задания также удаляются все задачи, которые являются частью этого задания, и все статистические данные заданий. Это также переопределяет период хранения для данных задачи; То есть, если задание содержит задачи, которые по-прежнему хранятся на вычислительных узлах, пакетные службы удаляют рабочие каталоги этих задач и все их содержимое. При получении запроса на удаление задания пакетная служба устанавливает для задания состояние удаления. Все операции обновления в задании, которое находится в состоянии удаления, завершатся сбоем с кодом состояния 409 (конфликт) и дополнительными сведениями о том, что задание удаляется.

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

Параметры

job_id

str

Обязательно

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

job_delete_options

JobDeleteOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

disable

Отключает указанное задание, предотвращая выполнение новых задач.

Пакетная служба немедленно переместит задание в состояние отключения. Затем пакетная служба использует параметр disableTasks, чтобы определить, что делать с текущими задачами задания. Задание остается в состоянии отключения, пока операция отключения не будет завершена и все задачи не будут обработаны в соответствии с параметром disableTasks; Затем задание переходит в отключенное состояние. Новые задачи не запускаются в задании, пока оно не перейдет в активное состояние. При попытке отключить задание, которое находится в состоянии, отличном от активного, отключенного или отключенного, запрос завершается ошибкой с кодом состояния 409.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

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

disable_tasks

str или DisableJobOption

Обязательно

Возможные значения: requeue, terminate, wait.

job_disable_options

JobDisableOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

enable

Включает указанное задание, позволяя выполнять новые задачи.

При вызове этого API пакетная служба устанавливает для отключенного задания состояние включения. После завершения этой операции задание переходит в активное состояние, а планирование новых задач в задании возобновляется. Пакетная служба не позволяет задаче оставаться в активном состоянии более 180 дней. Таким образом, если включить задание, содержащее активные задачи, которые были добавлены более 180 дней назад, эти задачи не будут выполняться.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

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

job_enable_options

JobEnableOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

get

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

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

Параметры

job_id

str

Обязательно

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

job_get_options

JobGetOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

CloudJob,

ClientRawResponse

Исключения

BatchErrorException

get_task_counts

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

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

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

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

job_get_task_counts_options

JobGetTaskCountsOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

TaskCountsResult,

ClientRawResponse

Исключения

BatchErrorException

list

Выводит список всех заданий в указанной учетной записи.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_list_options

JobListOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

CloudJobPaged[CloudJob]

Исключения

BatchErrorException

list_from_job_schedule

Список заданий, созданных в соответствии с указанным расписанием заданий.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_schedule_id

str

Обязательно

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

job_list_from_job_schedule_options

JobListFromJobScheduleOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

CloudJobPaged[CloudJob]

Исключения

BatchErrorException

list_preparation_and_release_task_status

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

Этот API возвращает состояние задачи подготовки задания и выпуска задания на всех вычислительных узлах, на которых запущена задача подготовки задания или выпуска задания. Сюда входят вычислительные узлы, которые были удалены из пула. Если этот API вызывается в задании, которое не имеет задачи подготовки задания или выпуска задания, пакетная служба возвращает код состояния HTTP 409 (конфликт) с кодом ошибки JobPreparationTaskNotSpecified.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

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

job_list_preparation_and_release_task_status_options

JobListPreparationAndReleaseTaskStatusOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

JobPreparationAndReleaseTaskExecutionInformationPaged[JobPreparationAndReleaseTaskExecutionInformation]

Исключения

BatchErrorException

patch

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

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

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, свойства которого требуется обновить.

job_patch_parameter

JobPatchParameter

Обязательно

Параметры для запроса.

job_patch_options

JobPatchOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

terminate

Завершает указанное задание, помечая его как завершенное.

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

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

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

terminate_reason

str

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

job_terminate_options

JobTerminateOptions

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

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

custom_headers

dict

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

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

raw

bool

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

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

operation_config

Обязательно

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

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

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

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

None,

ClientRawResponse

Исключения

BatchErrorException

update

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

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

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

Параметры

job_id

str

Обязательно

Идентификатор задания, свойства которого требуется обновить.

job_update_parameter

JobUpdateParameter

Обязательно

Параметры для запроса.

job_update_options

JobUpdateOptions

значение по умолчанию: 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'>