BatchJobSpecification interface

Пакет:

@azure/batch

Указывает сведения о заданиях, создаваемых по расписанию.

Свойства

allowTaskPreemption	Можно ли выполнять задачи в этом задании с высоким приоритетом. (Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки для получения дополнительной информации) Если значение установлено в True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут повторно ставить задачи в очередь из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption.
allTasksCompleteMode	Действие пакетной службы должно выполняться, когда все задачи в задании, созданном в рамках этого расписания, находятся в состоянии завершения. Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала необходимо задать значение noaction onAllTasksComplete и обновить свойства задания, чтобы задать значение onAllTasksComplete, чтобы завершить работу после завершения добавления задач. Значение по умолчанию — noaction.
commonEnvironmentSettings	Список общих параметров переменной среды. Эти переменные среды задаются для всех задач в заданиях, созданных в рамках этого расписания (включая диспетчер заданий, задачи подготовки заданий и выпуска заданий). Отдельные задачи могут переопределить параметр среды, указанный здесь, указав то же имя параметра с другим значением.
constraints	Ограничения выполнения для заданий, созданных в рамках этого расписания.
displayName	Отображаемое имя заданий, созданных в рамках этого расписания. Имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
jobManagerTask	Сведения о задаче диспетчера заданий, запускаемой при запуске задания в рамках этого расписания. Если задание не указывает задачу диспетчера заданий, пользователь должен явно добавить задачи в задание с помощью API задач. Если задание задает задачу диспетчера заданий, пакетная служба создает задачу Диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании.
jobPreparationTask	Задача подготовки заданий для заданий, созданных в рамках этого расписания. Если задание имеет задачу подготовки заданий, пакетная служба запустит задачу подготовки заданий на узле перед запуском любых задач этого задания на этом вычислительном узле.
jobReleaseTask	Задача выпуска задания для заданий, созданных в рамках этого расписания. Основной целью задачи выпуска задания является отмена изменений узлов, внесенных задачей подготовки задания. Примеры действий включают удаление локальных файлов или завершение работы служб, которые были запущены в процессе подготовки задания. Задача выпуска задания не может быть указана без указания задачи подготовки задания для задания. Пакетная служба запускает задачу выпуска задания на вычислительных узлах, на которых выполняется задача подготовки задания.
maxParallelTasks	Максимальное количество задач, которые могут выполняться параллельно для задания. (Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки для получения дополнительной информации) Значение maxParallelTasks должно быть -1 или больше 0, если указано. Если значение по умолчанию не указано, значение по умолчанию равно -1, что означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.
metadata	Список пар "имя-значение", связанных с каждым заданием, созданным в рамках этого расписания в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
networkConfiguration	(Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки за дополнительной информацией) Конфигурация сети для задания.
poolInfo	Пул, на котором служба пакетной службы выполняет задачи заданий, созданных в рамках этого расписания.
priority	Приоритет заданий, созданных в рамках этого расписания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0. Этот приоритет используется в качестве значения по умолчанию для всех заданий в разделе "Расписание заданий". Вы можете обновить приоритет задания после его создания с помощью API обновления задания.
taskFailureMode	Действие пакетной службы должно выполняться при сбое любой задачи в задании, созданном в рамках этого расписания. Задача считается неудачной, если она завершилась сбоем, если имеется ошибкаInfo. Параметр failureInfo устанавливается, если задача завершается с кодом выхода без нуля после исчерпания его количества повторных попыток или если возникла ошибка запуска задачи, например из-за ошибки загрузки файла ресурсов. Значение по умолчанию — noaction.
usesTaskDependencies	Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false.

Сведения о свойстве

allowTaskPreemption

Можно ли выполнять задачи в этом задании с высоким приоритетом. (Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки для получения дополнительной информации) Если значение установлено в True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут повторно ставить задачи в очередь из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption.

allowTaskPreemption?: boolean

Значение свойства

boolean

allTasksCompleteMode

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

allTasksCompleteMode?: BatchAllTasksCompleteMode

Значение свойства

BatchAllTasksCompleteMode

commonEnvironmentSettings

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

commonEnvironmentSettings?: EnvironmentSetting[]

Значение свойства

EnvironmentSetting[]

constraints

Ограничения выполнения для заданий, созданных в рамках этого расписания.

constraints?: BatchJobConstraints

Значение свойства

BatchJobConstraints

displayName

Отображаемое имя заданий, созданных в рамках этого расписания. Имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

displayName?: string

Значение свойства

string

jobManagerTask

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

jobManagerTask?: BatchJobManagerTask

Значение свойства

BatchJobManagerTask

jobPreparationTask

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

jobPreparationTask?: BatchJobPreparationTask

Значение свойства

BatchJobPreparationTask

jobReleaseTask

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

jobReleaseTask?: BatchJobReleaseTask

Значение свойства

BatchJobReleaseTask

maxParallelTasks

Максимальное количество задач, которые могут выполняться параллельно для задания. (Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки для получения дополнительной информации) Значение maxParallelTasks должно быть -1 или больше 0, если указано. Если значение по умолчанию не указано, значение по умолчанию равно -1, что означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.

maxParallelTasks?: number

Значение свойства

number

metadata

Список пар "имя-значение", связанных с каждым заданием, созданным в рамках этого расписания в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.

metadata?: BatchMetadataItem[]

Значение свойства

BatchMetadataItem[]

networkConfiguration

(Это свойство недоступно по умолчанию. Пожалуйста, обратитесь в службу поддержки за дополнительной информацией) Конфигурация сети для задания.

networkConfiguration?: BatchJobNetworkConfiguration

Значение свойства

BatchJobNetworkConfiguration

poolInfo

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

poolInfo: BatchPoolInfo

Значение свойства

BatchPoolInfo

priority

Приоритет заданий, созданных в рамках этого расписания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0. Этот приоритет используется в качестве значения по умолчанию для всех заданий в разделе "Расписание заданий". Вы можете обновить приоритет задания после его создания с помощью API обновления задания.

priority?: number

Значение свойства

number

taskFailureMode

Действие пакетной службы должно выполняться при сбое любой задачи в задании, созданном в рамках этого расписания. Задача считается неудачной, если она завершилась сбоем, если имеется ошибкаInfo. Параметр failureInfo устанавливается, если задача завершается с кодом выхода без нуля после исчерпания его количества повторных попыток или если возникла ошибка запуска задачи, например из-за ошибки загрузки файла ресурсов. Значение по умолчанию — noaction.

taskFailureMode?: BatchTaskFailureMode

Значение свойства

BatchTaskFailureMode

usesTaskDependencies

Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false.

usesTaskDependencies?: boolean

Значение свойства

boolean