BatchJobOutput interface

Пакет:
@azure-rest/batch

Пакетное задание Azure.

Свойства

allowTaskPreemption

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

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

Ограничения выполнения для задания.
creationTime

Время создания задания.
displayName

Отображаемое имя задания.
eTag

ETag задания. Это непрозрачная строка. Его можно использовать для определения того, изменилось ли задание между запросами. В частности, вы можете передать ETag при обновлении задания, чтобы указать, что изменения должны вступили в силу только в том случае, если никто другой не изменил задание в то же время.
executionInfo

Сведения о выполнении задания.
id

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

Сведения о задаче диспетчера заданий, запускаемой при запуске задания.
jobPreparationTask

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

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

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

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

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

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

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

Возможные значения: noaction, "terminatejob"
onTaskFailure

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

Возможные значения: noaction, "performexitoptionsjobaction"
poolInfo

Параметры пула, связанные с заданием.
previousState

Предыдущее состояние задания. Это свойство не задано, если задание находится в исходном состоянии "Активный".

Возможные значения: "активный", "отключение", "отключено", "включение", "завершение", "завершено", "удаление"
previousStateTransitionTime

Время ввода задания в предыдущее состояние. Это свойство не задано, если задание находится в исходном состоянии "Активный".
priority

Приоритет задания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0.
state

Текущее состояние задания.

Возможные значения: "активный", "отключение", "отключено", "включение", "завершение", "завершено", "удаление"
stateTransitionTime

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

Статистика использования ресурсов в течение всего времени существования задания. Это свойство заполняется только в том случае, если пакетный заданий был получен с предложением expand, включая атрибут stats; в противном случае значение null. Статистика может быть недоступна сразу. Пакетная служба выполняет периодический свертки статистики. Типичная задержка составляет около 30 минут.
url

URL-адрес задания.
usesTaskDependencies

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

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

allowTaskPreemption

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

allowTaskPreemption?: boolean

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

boolean

commonEnvironmentSettings

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

commonEnvironmentSettings?: EnvironmentSettingOutput[]

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

EnvironmentSettingOutput[]

constraints

Ограничения выполнения для задания.

constraints?: BatchJobConstraintsOutput

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

BatchJobConstraintsOutput

creationTime

Время создания задания.

creationTime: string

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

string

displayName

Отображаемое имя задания.

displayName?: string

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

string

eTag

ETag задания. Это непрозрачная строка. Его можно использовать для определения того, изменилось ли задание между запросами. В частности, вы можете передать ETag при обновлении задания, чтобы указать, что изменения должны вступили в силу только в том случае, если никто другой не изменил задание в то же время.

eTag: string

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

string

executionInfo

Сведения о выполнении задания.

executionInfo?: BatchJobExecutionInfoOutput

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

BatchJobExecutionInfoOutput

id

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

id: string

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

string

jobManagerTask

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

jobManagerTask?: BatchJobManagerTaskOutput

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

BatchJobManagerTaskOutput

jobPreparationTask

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

jobPreparationTask?: BatchJobPreparationTaskOutput

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

BatchJobPreparationTaskOutput

jobReleaseTask

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

jobReleaseTask?: BatchJobReleaseTaskOutput

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

BatchJobReleaseTaskOutput

lastModified

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

lastModified: string

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

string

maxParallelTasks

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

maxParallelTasks?: number

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

number

metadata

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

metadata?: BatchMetadataItemOutput[]

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

BatchMetadataItemOutput[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfigurationOutput

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

BatchJobNetworkConfigurationOutput

onAllTasksComplete

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

Возможные значения: noaction, "terminatejob"

onAllTasksComplete?: string

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

string

onTaskFailure

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

Возможные значения: noaction, "performexitoptionsjobaction"

onTaskFailure?: string

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

string

poolInfo

Параметры пула, связанные с заданием.

poolInfo: BatchPoolInfoOutput

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

BatchPoolInfoOutput

previousState

Предыдущее состояние задания. Это свойство не задано, если задание находится в исходном состоянии "Активный".

Возможные значения: "активный", "отключение", "отключено", "включение", "завершение", "завершено", "удаление"

previousState?: string

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

string

previousStateTransitionTime

Время ввода задания в предыдущее состояние. Это свойство не задано, если задание находится в исходном состоянии "Активный".

previousStateTransitionTime?: string

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

string

priority

Приоритет задания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0.

priority?: number

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

number

state

Текущее состояние задания.

Возможные значения: "активный", "отключение", "отключено", "включение", "завершение", "завершено", "удаление"

state: string

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

string

stateTransitionTime

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

stateTransitionTime: string

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

string

stats

Статистика использования ресурсов в течение всего времени существования задания. Это свойство заполняется только в том случае, если пакетный заданий был получен с предложением expand, включая атрибут stats; в противном случае значение null. Статистика может быть недоступна сразу. Пакетная служба выполняет периодический свертки статистики. Типичная задержка составляет около 30 минут.

stats?: BatchJobStatisticsOutput

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

BatchJobStatisticsOutput

url

URL-адрес задания.

url: string

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

string

usesTaskDependencies

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

usesTaskDependencies?: boolean

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

boolean