BatchTaskOutput interface

Пакет:

@azure-rest/batch

Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач.

Свойства

affinityInfo	Указание локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором будет запущена новая задача.
applicationPackageReferences	Список пакетов, которые служба пакетной службы развертывает на вычислительном узле перед выполнением командной строки. Пакеты приложений загружаются и развертываются в общий каталог, а не в рабочий каталог задач. Таким образом, если указанный пакет уже находится на узле и находится в актуальном состоянии, он не скачан повторно; Используется существующую копию на вычислительном узле. Если не удается установить указанный пакет, например из-за того, что пакет был удален или сбой загрузки, задача завершается ошибкой.
authenticationTokenSettings	Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. Если это свойство задано, пакетная служба предоставляет задачу с маркером проверки подлинности, который можно использовать для проверки подлинности операций пакетной службы без необходимости ключа доступа к учетной записи. Маркер предоставляется с помощью переменной среды AZ_BATCH_AUTHENTICATION_TOKEN. Операции, которые задача может выполнять с помощью маркера, зависят от параметров. Например, задача может запрашивать разрешения задания, чтобы добавить другие задачи в задание, или проверить состояние задания или других задач в задании.
commandLine	Командная строка задачи. Для задач с несколькими экземплярами командная строка выполняется в качестве основной задачи после завершения выполнения основной задачи и всех подзадач, выполняющих командную строку координации. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	Ограничения выполнения, применяемые к этой задаче.
containerSettings	Параметры контейнера, в котором выполняется задача. Если пул, который будет запускать эту задачу, имеет набор containerConfiguration, это также должно быть задано. Если пул, который будет запускать эту задачу, не имеет набора containerConfiguration, это не должно быть задано. При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корневой каталог пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.
creationTime	Время создания задачи.
dependsOn	Задачи, от которые зависит эта задача. Эта задача не будет запланирована до тех пор, пока все задачи, от которых она зависит, успешно завершены. Если любой из этих задач завершается сбоем и исчерпает количество повторных попыток, эта задача никогда не будет запланирована.
displayName	Отображаемое имя задачи. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
environmentSettings	Список параметров переменной среды для задачи.
eTag	ETag задачи. Это непрозрачная строка. Его можно использовать для определения того, изменилась ли задача между запросами. В частности, вы можете передать ETag при обновлении задачи, чтобы указать, что изменения должны вступили в силу только в том случае, если никто другой не изменил задачу в то же время.
executionInfo	Сведения о выполнении задачи.
exitConditions	Как служба пакетной службы должна реагировать при завершении задачи.
id	Строка, которая однозначно идентифицирует задачу в задании. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов.
lastModified	Время последнего изменения задачи.
multiInstanceSettings	Объект, указывающий, что задача является задачей с несколькими экземплярами и содержит сведения о выполнении задачи с несколькими экземплярами.
nodeInfo	Сведения о вычислительном узле, на котором выполнялась задача.
outputFiles	Список файлов, которые служба пакетной службы будет отправлять из вычислительного узла после выполнения командной строки. Для задач с несколькими экземплярами файлы будут отправляться только из вычислительного узла, на котором выполняется основная задача.
previousState	Предыдущее состояние задачи. Это свойство не задано, если задача находится в исходном состоянии "Активный". Возможные значения: "активный", "подготовка", "выполняется", "завершено"
previousStateTransitionTime	Время ввода задачи в предыдущее состояние. Это свойство не задано, если задача находится в исходном состоянии "Активный".
requiredSlots	Количество слотов планирования, которые требуется выполнить задаче. Значение по умолчанию — 1. Задача может выполняться только на вычислительном узле, если узел имеет достаточно свободных слотов планирования. Для задач с несколькими экземплярами это должно быть 1.
resourceFiles	Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Для задач с несколькими экземплярами файлы ресурсов будут загружены только на вычислительный узел, на котором выполняется основная задача. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
state	Текущее состояние задачи. Возможные значения: "активный", "подготовка", "выполняется", "завершено"
stateTransitionTime	Время ввода задачи в текущее состояние.
stats	Статистика использования ресурсов для задачи.
url	URL-адрес задачи.
userIdentity	Удостоверение пользователя, под которым выполняется задача. Если опущен, задача выполняется как пользователь, отличный от администрирования, уникальным для задачи.

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

affinityInfo

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

affinityInfo?: BatchAffinityInfoOutput

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

BatchAffinityInfoOutput

applicationPackageReferences

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

applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]

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

BatchApplicationPackageReferenceOutput[]

authenticationTokenSettings

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

authenticationTokenSettings?: AuthenticationTokenSettingsOutput

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

AuthenticationTokenSettingsOutput

commandLine

Командная строка задачи. Для задач с несколькими экземплярами командная строка выполняется в качестве основной задачи после завершения выполнения основной задачи и всех подзадач, выполняющих командную строку координации. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

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

string

constraints

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

constraints?: BatchTaskConstraintsOutput

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

BatchTaskConstraintsOutput

containerSettings

Параметры контейнера, в котором выполняется задача. Если пул, который будет запускать эту задачу, имеет набор containerConfiguration, это также должно быть задано. Если пул, который будет запускать эту задачу, не имеет набора containerConfiguration, это не должно быть задано. При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корневой каталог пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.

containerSettings?: BatchTaskContainerSettingsOutput

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

BatchTaskContainerSettingsOutput

creationTime

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

creationTime: string

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

string

dependsOn

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

dependsOn?: BatchTaskDependenciesOutput

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

BatchTaskDependenciesOutput

displayName

Отображаемое имя задачи. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

displayName?: string

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

string

environmentSettings

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

environmentSettings?: EnvironmentSettingOutput[]

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

EnvironmentSettingOutput[]

eTag

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

eTag: string

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

string

executionInfo

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

executionInfo?: BatchTaskExecutionInfoOutput

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

BatchTaskExecutionInfoOutput

exitConditions

Как служба пакетной службы должна реагировать при завершении задачи.

exitConditions?: ExitConditionsOutput

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

ExitConditionsOutput

id

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

id: string

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

string

lastModified

Время последнего изменения задачи.

lastModified: string

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

string

multiInstanceSettings

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

multiInstanceSettings?: MultiInstanceSettingsOutput

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

MultiInstanceSettingsOutput

nodeInfo

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

nodeInfo?: BatchNodeInfoOutput

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

BatchNodeInfoOutput

outputFiles

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

outputFiles?: OutputFileOutput[]

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

OutputFileOutput[]

previousState

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

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

previousState?: string

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

string

previousStateTransitionTime

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

previousStateTransitionTime?: string

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

string

requiredSlots

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

requiredSlots?: number

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

number

resourceFiles

Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Для задач с несколькими экземплярами файлы ресурсов будут загружены только на вычислительный узел, на котором выполняется основная задача. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.

resourceFiles?: ResourceFileOutput[]

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

ResourceFileOutput[]

state

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

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

state: string

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

string

stateTransitionTime

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

stateTransitionTime: string

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

string

stats

Статистика использования ресурсов для задачи.

stats?: BatchTaskStatisticsOutput

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

BatchTaskStatisticsOutput

url

URL-адрес задачи.

url: string

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

string

userIdentity

Удостоверение пользователя, под которым выполняется задача. Если опущен, задача выполняется как пользователь, отличный от администрирования, уникальным для задачи.

userIdentity?: UserIdentityOutput

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

UserIdentityOutput