BatchJobCreateOptions interface

Пакет:

@azure/batch

Parameters for creating an пакетная служба Azure Job.

Свойства

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

id

Строка, которая однозначно идентифицирует задание в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор является сохранением регистра и не учитывает регистр (т. е. у вас не может быть двух идентификаторов в учетной записи, которые отличаются только по регистру).

id: string

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

string

jobManagerTask

Сведения о задаче диспетчера заданий, запускаемой при запуске задания. Если задание не указывает задачу диспетчера заданий, пользователь должен явно добавить задачи в задание. Если задание задает задачу диспетчера заданий, пакетная служба создает задачу Диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании. Типичная цель задачи диспетчера заданий заключается в управлении выполнением заданий и (или) мониторинге, например путем определения дополнительных задач выполнения, определения завершения работы и т. д. (Однако задача диспетчера заданий не ограничена этими действиями — это полная задача в системе и выполнение любых действий, необходимых для задания.) Например, задача диспетчера заданий может скачать файл, указанный в качестве параметра, проанализировать содержимое этого файла и отправить дополнительные задачи на основе этого содержимого.

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.

priority?: number

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

number

taskFailureMode

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

taskFailureMode?: BatchTaskFailureMode

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

BatchTaskFailureMode

usesTaskDependencies

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

usesTaskDependencies?: boolean

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

boolean