Task - Add

Добавляет задачу в указанное задание.
Максимальное время существования задачи от добавления до завершения — 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет прервана пакетной службой и останется в том состоянии, в котором она находилась в это время.

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2021-06-01.14.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2021-06-01.14.0

Параметры URI

Name In Required Type Description
batchUrl
path True
  • string

Базовый URL-адрес для всех запросов пакетной службы Azure.

jobId
path True
  • string

Идентификатор задания, к которому добавляется задача.

api-version
query True
  • string

Версия API клиента.

timeout
query
  • integer
int32

Максимальное время, в течение которого сервер может потратить на обработку запроса (в секундах). По умолчанию это 30 секунд.

Заголовок запроса

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

Формируемый вызывающим объектом идентификатор запроса в виде идентификатора GUID без декорирования, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Должен ли сервер возвращать в ответе клиент-Request-ID.

ocp-date
  • string
date-time-rfc1123

Время выдачи запроса. Клиентские библиотеки обычно устанавливают это значение в соответствии с текущим системным временем. Задайте его явно, если вы вызываете REST API напрямую.

Текст запроса

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
commandLine True
  • string

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

id True
  • string

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

affinityInfo

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

applicationPackageReferences

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

authenticationTokenSettings

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

constraints

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

containerSettings

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

dependsOn

Задачи, от которых зависит эта задача.
Эта задача не будет запланирована, пока не будут успешно выполнены все задачи, от которых она зависит. Если какая либо из этих задач завершилась сбоем и исчерпала количество повторных попыток, эта задача не будет запланирована. Если в задании не задано значение true для параметра usesTaskDependencies, а этот элемент существует, запрос завершается с кодом ошибки ТаскдепенденЦиеснотспеЦифиедонжоб.

displayName
  • string

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

environmentSettings

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

exitConditions

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

multiInstanceSettings

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

outputFiles

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

requiredSlots
  • integer

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

resourceFiles

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

userIdentity

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

Ответы

Name Type Description
201 Created

Запрос к пакетной службе выполнен успешно.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

Ошибка пакетной службы.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Add a basic task
Add a task with container settings
Add a task with exit conditions
Add a task with extra slot requirement

Add a basic task

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Sample Response

Add a task with container settings

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with exit conditions

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with extra slot requirement

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Sample Response

Определения

AffinityInformation

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

ApplicationPackageReference

Ссылка на пакет, который должен быть развернут на кластерных узлах.

AuthenticationTokenSettings

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

AutoUserScope

Область для автоматического пользователя

AutoUserSpecification

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

BatchError

Ответ на ошибку, полученный от пакетной службы Azure.

BatchErrorDetail

Элемент дополнительных сведений, содержащихся в ответе на ошибку пакетной службы Azure.

ComputeNodeIdentityReference

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

ContainerRegistry

Закрытый реестр контейнеров.

ContainerWorkingDirectory

Расположение рабочего каталога задачи контейнера.

DependencyAction

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

ElevationLevel

Уровень повышения прав пользователя.

EnvironmentSetting

Переменная среды, которая должна быть задана в процессе задачи.

ErrorMessage

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

ExitCodeMapping

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

ExitCodeRangeMapping

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

ExitConditions

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

ExitOptions

Указывает, как пакетная служба реагирует на определенное условие выхода.

JobAction

Действие, выполняемое над заданием, содержащим задачу, если задача завершается с заданным условием выхода и свойством onTaskFailed задания является "Перформекситоптионсжобактион".

MultiInstanceSettings

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

OutputFile

Спецификация отправки файлов из расчетного узла пакетной службы Azure в другое расположение после того, как пакетная служба завершит исполнение процесса задачи.

OutputFileBlobContainerDestination

Указывает место назначения отправки файла в контейнере хранилища BLOB-объектов Azure.

OutputFileDestination

Место назначения, куда будет отправлен файл.

OutputFileUploadCondition

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

OutputFileUploadOptions

Сведения о операции отправки выходного файла, включая условия для выполнения отправки.

ResourceFile

Один файл или несколько файлов для загрузки на узел вычислений.

TaskAddParameter

Задача пакетной службы Azure для добавления.

TaskConstraints

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

TaskContainerSettings

Параметры контейнера для задачи.

TaskDependencies

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

TaskIdRange

Диапазон идентификаторов задач, от которых может зависеть задача. Все задачи с идентификаторами в диапазоне должны быть успешно выполнены, прежде чем можно будет запланировать зависимую задачу.

UserIdentity

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

AffinityInformation

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

Name Type Description
affinityId
  • string

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

ApplicationPackageReference

Ссылка на пакет, который должен быть развернут на кластерных узлах.

Name Type Description
applicationId
  • string

Идентификатор приложения для развертывания.

version
  • string

Версия развертываемого приложения. Если этот параметр опущен, развертывается версия по умолчанию.
Если этот параметр пропущен в пуле и для этого приложения не указана версия по умолчанию, запрос завершается ошибкой с кодом ошибки Инвалидаппликатионпаккажереференцес и кодом состояния HTTP 409. Если в задаче не указано, а для этого приложения не указана версия по умолчанию, то задача завершается ошибкой предварительной обработки.

AuthenticationTokenSettings

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

Name Type Description
access
  • string[]

Ресурсы пакетной службы, к которым маркер предоставляет доступ.
Маркер аутентификации предоставляет доступ к ограниченному набору операций пакетной службы. В настоящее время единственным поддерживаемым значением для свойства доступа является "Job", которое предоставляет доступ ко всем операциям, связанным с заданием, которое содержит задачу.

AutoUserScope

Область для автоматического пользователя

Name Type Description
pool
  • string

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

task
  • string

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

AutoUserSpecification

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

Name Type Description
elevationLevel

Уровень возвышения автоматического пользователя.
Значение по умолчанию — не администратор.

scope

Область для автоматического пользователя
Значение по умолчанию — pool. если пул работает Windows необходимо указать значение Task, если требуется более длительная изоляция между задачами. Например, если задача изменяет реестр так, что может повлиять на другие задачи, или если в пуле были указаны сертификаты, которые не должны быть доступны обычным задачам, но должны быть доступны для Старттаскс.

BatchError

Ответ на ошибку, полученный от пакетной службы Azure.

Name Type Description
code
  • string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

message

Сообщение с описанием ошибки, которое должно быть подходящим для вывода в пользовательском интерфейсе.

values

Коллекция пар "ключ-значение", содержащих дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, содержащихся в ответе на ошибку пакетной службы Azure.

Name Type Description
key
  • string

Идентификатор, указывающий значение свойства Value.

value
  • string

Дополнительные сведения, содержащиеся в ответе на ошибку.

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

Идентификатор ресурса ARM для назначенного пользователем удостоверения.

ContainerRegistry

Закрытый реестр контейнеров.

Name Type Description
identityReference

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

password
  • string

Пароль для входа на сервер реестра.

registryServer
  • string

URL-адрес реестра.
Если этот параметр опущен, по умолчанию используется значение "docker.io".

username
  • string

Имя пользователя для входа на сервер реестра.

ContainerWorkingDirectory

Расположение рабочего каталога задачи контейнера.

Name Type Description
containerImageDefault
  • string

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

taskWorkingDirectory
  • string

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

DependencyAction

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

Name Type Description
block
  • string

Блокирует задачи, ожидающие этой задачи, предотвращая их планирование.

satisfy
  • string

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

ElevationLevel

Уровень повышения прав пользователя.

Name Type Description
admin
  • string

Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора.

nonadmin
  • string

Пользователь является обычным пользователем без повышенного доступа.

EnvironmentSetting

Переменная среды, которая должна быть задана в процессе задачи.

Name Type Description
name
  • string

Имя переменной среды.

value
  • string

Значение переменной среды.

ErrorMessage

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Name Type Description
lang
  • string

Код языка сообщения об ошибке

value
  • string

Текст сообщения.

ExitCodeMapping

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

Name Type Description
code
  • integer

Код завершения процесса.

exitOptions

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

ExitCodeRangeMapping

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

Name Type Description
end
  • integer

Последний код выхода в диапазоне.

exitOptions

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

start
  • integer

Первый код выхода в диапазоне.

ExitConditions

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

Name Type Description
default

Как служба пакетной службы должна реагировать в случае сбоя задачи с условием выхода, не охваченным другими свойствами.
Это значение используется, если задача завершается с ненулевым кодом выхода, отсутствующим в коллекции exitCodes или exitCodeRanges, с ошибкой предварительной обработки, если свойство Препроцессинжеррор отсутствует, или с ошибкой передачи файла, если отсутствует свойство Филеуплоадеррор. Если требуется не заданное по умолчанию поведение для кода выхода 0, его необходимо перечислить явным образом с помощью коллекции exitCodes или exitCodeRanges.

exitCodeRanges

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

exitCodes

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

fileUploadError

Ответ пакетной службы в случае возникновения ошибки передачи файла.
Если задача завершилась с кодом выхода, который был указан с помощью exitCodes или exitCodeRanges, а затем обнаружил ошибку передачи файла, приоритет имеет действие, указанное в коде выхода.

preProcessingError

Способ реагирования пакетной службы, если задача не запускается из-за ошибки.

ExitOptions

Указывает, как пакетная служба реагирует на определенное условие выхода.

Name Type Description
dependencyAction

Действие, выполняемое пакетной службой в задачах, зависящих от этой задачи.
Возможные значения: "удовлетворения" (разрешено выполнение зависимых задач) и "Block" (зависимые задачи продолжают ожидать). Пакетная обработка еще не поддерживает отмену зависимых задач.

jobAction

Действие, выполняемое над заданием, содержащим задачу, если задача завершается с заданным условием выхода и свойством onTaskFailed задания является "Перформекситоптионсжобактион".
Значение по умолчанию — None для кода выхода 0 и завершение для всех остальных условий выхода. Если свойство onTaskFailed задания имеет значение "unaction", то при указании этого свойства возвращается ошибка, а запрос на добавление задачи завершается ошибкой с недопустимым значением свойства. Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

JobAction

Действие, выполняемое над заданием, содержащим задачу, если задача завершается с заданным условием выхода и свойством onTaskFailed задания является "Перформекситоптионсжобактион".

Name Type Description
disable
  • string

Отключите задание. Это эквивалентно вызову API отключения задания со значением Дисаблетаскс в Queue.

none
  • string

Не предпринимать никаких действий.

terminate
  • string

Завершите задание. Терминатереасон в executionInfo задания имеет значение "Таскфаилед".

MultiInstanceSettings

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

Name Type Description
commonResourceFiles

Список файлов, которые будут скачаны пакетной службой, прежде чем выполнять командную строку координации.
Различие между общими файлами ресурсов и файлами ресурсов задач заключается в том, что файлы общих ресурсов загружаются для всех подзадач, включая первичный, а файлы ресурсов задач загружаются только для первичной реплики. Кроме того, обратите внимание, что эти файлы ресурсов не загружаются в рабочий каталог задачи, а загружаются в корневой каталог задачи (один каталог над рабочим каталогом). Максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет Рекуестентититуларже. Если это происходит, коллекция ResourceFiles должна быть уменьшена по размеру. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров DOCKER.

coordinationCommandLine
  • string

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

numberOfInstances
  • integer

Число узлов вычислений, необходимых для задачи.
Если этот параметр опущен, по умолчанию используется значение 1.

OutputFile

Спецификация отправки файлов из расчетного узла пакетной службы Azure в другое расположение после того, как пакетная служба завершит исполнение процесса задачи.

Name Type Description
destination

Место назначения для выходных файлов.

filePattern
  • string

Шаблон, указывающий, какие файлы нужно передать.
Поддерживаются как относительные, так и абсолютные пути. Относительные пути задаются относительно рабочего каталога задачи. Поддерживаются следующие подстановочные знаки: * соответствует 0 или более символов (например, шаблон ABC * соответствует ABC или abcdef), * * соответствует любому каталогу,? соответствует любому отдельному символу, [abc] соответствует одному символу в квадратных скобках, а [a-c] соответствует одному символу в диапазоне. Квадратные скобки могут включать отрицание, чтобы соответствовать любому символу, который не указан (например, [! abc] соответствует любому символу, но a, b или c). Если имя файла начинается с ".", оно игнорируется по умолчанию, но может быть сопоставлено явным образом (например .gif не будет соответствовать .a.gif, но..gif будет). Простой пример: ***.txt соответствует любому файлу, который не начинается с "." и заканчивается .txt в рабочем каталоге задачи или в любом подкаталоге. Если имя файла содержит подстановочный знак, его можно заключать в квадратные скобки (например, ABC [*] соответствует файлу с именем ABC *). обратите внимание, что и , и (/) обрабатываются как разделители каталогов в Windows, но только в Linux. переменные среды (% var% для Windows или $var в Linux) развернуты до применения шаблона.

uploadOptions

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

OutputFileBlobContainerDestination

Указывает место назначения отправки файла в контейнере хранилища BLOB-объектов Azure.

Name Type Description
containerUrl
  • string

URL-адрес контейнера в служба хранилища больших двоичных объектов Azure, куда нужно передать файлы.
Если управляемое удостоверение не используется, URL-адрес должен содержать подписанный на нее сертификат общего доступа (SAS), предоставляющий разрешения на запись в контейнер.

identityReference

ссылка на удостоверение пользователя, которое будет использоваться для доступа к служба хранилища больших двоичных объектов Azure, заданных параметром containerUrl
удостоверение должно иметь доступ на запись к контейнеру служба хранилища больших двоичных объектов Azure.

path
  • string

целевой большой двоичный объект или виртуальный каталог в контейнере служба хранилища Azure.
Если filePattern ссылается на конкретный файл (т. е. не содержит подстановочных знаков), то Path — это имя большого двоичного объекта, в который будет отправлен этот файл. Если filePattern содержит один или несколько подстановочных знаков (и, следовательно, может соответствовать нескольким файлам), то Path — это имя виртуального каталога большого двоичного объекта (который добавляется в начало каждого имени большого двоичного объекта), куда будут отправляться файлы. Если этот параметр не указан, файлы передаются в корень контейнера с именем большого двоичного объекта, совпадающим с именем файла.

OutputFileDestination

Место назначения, куда будет отправлен файл.

Name Type Description
container

Расположение в хранилище BLOB-объектов Azure, куда отправляются файлы.

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

Upload файлы после завершения процесса задачи, независимо от кода выхода.

taskfailure
  • string

Upload файлы только после завершения процесса задачи с ненулевым кодом выхода.

tasksuccess
  • string

Upload файлы только после выхода из процесса задачи с кодом выхода 0.

OutputFileUploadOptions

Сведения о операции отправки выходного файла, включая условия для выполнения отправки.

Name Type Description
uploadCondition

Условия, при которых необходимо передать выходной файл или набор файлов задачи.
Значение по умолчанию — taskcompletion.

ResourceFile

Один файл или несколько файлов для загрузки на узел вычислений.

Name Type Description
autoStorageContainerName
  • string

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

blobPrefix
  • string

префикс большого двоичного объекта, используемый при загрузке больших двоичных объектов из контейнера служба хранилища Azure. Будут скачаны только большие двоичные объекты, имена которых начинаются с указанного префикса.
Свойство допустимо, только если используется Аутосторажеконтаинернаме или Сторажеконтаинерурл. Этот префикс может быть частичным именем файла или вложенным каталогом. Если префикс не указан, будут скачаны все файлы в контейнере.

fileMode
  • string

Атрибут режима разрешений файла в восьмеричном формате.
Это свойство применяется только к файлам, загружаемым на расчетные узлы Linux. он будет проигнорирован, если он указан для resourceFile, который будет скачан на Windowsный узел. Если это свойство не указано для расчетного узла Linux, то к файлу применяется значение по умолчанию 0770.

filePath
  • string

Расположение на кластерном узле, куда следует загрузить файлы, относительно рабочего каталога задачи.
Если указано свойство Хттпурл, путь к файлу является обязательным и содержит описание пути, в который будет загружен файл, включая имя файла. В противном случае, если задано свойство Аутосторажеконтаинернаме или Сторажеконтаинерурл, путь к файлу является необязательным и является каталогом для скачивания файлов. Если путь к папке используется в качестве каталога, все структуры каталогов, уже связанные с входными данными, будут храниться в полном виде и добавлены к указанному каталогу filePath. Указанный относительный путь не может прерывать рабочий каталог задачи (например, с помощью "..").

httpUrl
  • string

URL-адрес для скачивания файла.
Свойства Аутосторажеконтаинернаме, Сторажеконтаинерурл и Хттпурл являются взаимоисключающими, и один из них должен быть указан. если URL-адрес указывает на служба хранилища больших двоичных объектов Azure, он должен быть доступен для чтения с узлов вычислений. Существует три способа получить такой URL-адрес для большого двоичного объекта в службе хранилища Azure: включить подписанный общий доступ (SAS), предоставив разрешения на чтение для большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать список ACL для большого двоичного объекта или контейнера, чтобы разрешить общий доступ.

identityReference

ссылка на удостоверение пользователя, которое будет использоваться для доступа к служба хранилища больших двоичных объектов Azure, заданных параметром сторажеконтаинерурл или хттпурл
Ссылка на удостоверение, назначенное пользователем, связанное с пулом пакетной службы, который будет использоваться на вычисленном узле.

storageContainerUrl
  • string

URL-адрес контейнера больших двоичных объектов в служба хранилища больших двоичных объектов Azure.
Свойства Аутосторажеконтаинернаме, Сторажеконтаинерурл и Хттпурл являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и может быть представлен в виде списка из узлов вычислений. Существует три способа получить такой URL-адрес для контейнера в службе хранилища Azure: включить подписанный общий доступ (SAS), предоставив разрешения на чтение и список в контейнере, использовать управляемое удостоверение с разрешениями на чтение и список или установить список ACL для контейнера, чтобы разрешить общий доступ.

TaskAddParameter

Задача пакетной службы Azure для добавления.

Name Type Description
affinityInfo

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

applicationPackageReferences

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

authenticationTokenSettings

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

commandLine
  • string

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

constraints

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

containerSettings

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

dependsOn

Задачи, от которых зависит эта задача.
Эта задача не будет запланирована, пока не будут успешно выполнены все задачи, от которых она зависит. Если какая либо из этих задач завершилась сбоем и исчерпала количество повторных попыток, эта задача не будет запланирована. Если в задании не задано значение true для параметра usesTaskDependencies, а этот элемент существует, запрос завершается с кодом ошибки ТаскдепенденЦиеснотспеЦифиедонжоб.

displayName
  • string

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

environmentSettings

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

exitConditions

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

id
  • string

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

multiInstanceSettings

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

outputFiles

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

requiredSlots
  • integer

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

resourceFiles

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

userIdentity

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

TaskConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

Максимальное число повторных попыток выполнения задачи. Пакетная служба повторяет задачу, если ее код выхода не равен нулю.
Обратите внимание, что это значение определяет количество повторных попыток для исполняемого файла задачи из-за ненулевого кода выхода. Пакетная Служба попытается выполнить задачу один раз, а затем может повторить попытку до этого предела. Например, если максимальное число повторных попыток равно 3, пакетная задача повторяет задачу до 4 раз (одна начальная попытка и 3 повтора). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу после первой попытки. Если максимальное число повторных попыток равно-1, пакетная служба повторяет задачу без ограничения.

maxWallClockTime
  • string

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

retentionTime
  • string

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

TaskContainerSettings

Параметры контейнера для задачи.

Name Type Description
containerRunOptions
  • string

Дополнительные параметры для команды контейнера Create.
Эти дополнительные параметры предоставляются в качестве аргументов команды "DOCKER Create" в дополнение к тем, которые управляются пакетной службой.

imageName
  • string

Образ, используемый для создания контейнера, в котором будет выполняться задача.
Это полная ссылка на образ, которая будет указана как "docker pull". Если в имени образа не указан тег, в качестве значения по умолчанию используется тег ": latest".

registry

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

workingDirectory

Расположение рабочего каталога задачи контейнера.
Значение по умолчанию — "Таскворкингдиректори".

TaskDependencies

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

Name Type Description
taskIdRanges

Список диапазонов ИДЕНТИФИКАТОРов задач, от которых зависит эта задача. Все задачи во всех диапазонах должны быть успешно выполнены, прежде чем можно будет запланировать зависимую задачу.

taskIds
  • string[]

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

TaskIdRange

Диапазон идентификаторов задач, от которых может зависеть задача. Все задачи с идентификаторами в диапазоне должны быть успешно выполнены, прежде чем можно будет запланировать зависимую задачу.

Name Type Description
end
  • integer

Идентификатор последней задачи в диапазоне.

start
  • integer

Первый идентификатор задачи в диапазоне.

UserIdentity

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

Name Type Description
autoUser

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

username
  • string

Имя удостоверения пользователя, под которым выполняется задача.
Свойства userName и автопользователь являются взаимоисключающими. необходимо указать один из них, но не оба.