Поделиться через

BatchTaskCreateOptions interface

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

Параметры для создания задачи пакетной службы Azure.

Свойства

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

Ограничения выполнения, применяемые к этой задаче. Если ограничения не указаны, maxTaskRetryCount — это maxTaskRetryCount, указанный для задания, maxWallClockTime является бесконечным, а время хранения — 7 дней.
containerSettings

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

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

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

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

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

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

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

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

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

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

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

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

affinityInfo

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

affinityInfo?: BatchAffinityInfo

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

BatchAffinityInfo

applicationPackageReferences

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

applicationPackageReferences?: BatchApplicationPackageReference[]

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

BatchApplicationPackageReference[]

authenticationTokenSettings

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

authenticationTokenSettings?: AuthenticationTokenSettings

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

AuthenticationTokenSettings

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

Ограничения выполнения, применяемые к этой задаче. Если ограничения не указаны, maxTaskRetryCount — это maxTaskRetryCount, указанный для задания, maxWallClockTime является бесконечным, а время хранения — 7 дней.

constraints?: BatchTaskConstraints

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

BatchTaskConstraints

containerSettings

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

containerSettings?: BatchTaskContainerSettings

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

BatchTaskContainerSettings

dependsOn

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

dependsOn?: BatchTaskDependencies

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

BatchTaskDependencies

displayName

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

displayName?: string

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

string

environmentSettings

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

environmentSettings?: EnvironmentSetting[]

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

EnvironmentSetting[]

exitConditions

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

exitConditions?: ExitConditions

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

ExitConditions

id

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

id: string

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

string

multiInstanceSettings

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

multiInstanceSettings?: MultiInstanceSettings

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

MultiInstanceSettings

outputFiles

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

outputFiles?: OutputFile[]

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

OutputFile[]

requiredSlots

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

requiredSlots?: number

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

number

resourceFiles

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

resourceFiles?: ResourceFile[]

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

ResourceFile[]

userIdentity

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

userIdentity?: UserIdentity

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

UserIdentity