Task - Add
Добавляет задачу в указанное задание.
Максимальное время существования задачи с момента добавления до завершения составляет 180 дней. Если задача не была завершена в течение 180 дней после добавления, она будет завершена пакетной службой и останется в любом состоянии, в которой она находилась на тот момент.
POST {batchUrl}/jobs/{jobId}/tasks?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
job
|
path | True |
string |
Идентификатор задания, к которому добавляется задача. |
api-version
|
query | True |
string |
Версия API клиента. |
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
client-request-id |
string uuid |
Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Указывает, должен ли сервер возвращать client-request-id в ответе. |
|
ocp-date |
string date-time-rfc1123 |
Время отправки запроса. Клиентские библиотеки обычно устанавливают текущее системное время; Задайте его явным образом, если вы вызываете REST API напрямую. |
Текст запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
commandLine | True |
string |
Командная строка задачи. |
id | True |
string |
Строка, однозначно идентифицирующая задачу в задании. |
affinityInfo |
Указание о локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором будет запущена новая задача. |
||
applicationPackageReferences |
Список пакетов, которые пакетная служба будет развертывать на вычислительном узле перед запуском командной строки. |
||
authenticationTokenSettings |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
||
constraints |
Ограничения выполнения, применяемые к этой задаче. |
||
containerSettings |
Параметры контейнера, в котором выполняется задача. |
||
dependsOn |
Задачи, от которые зависит эта задача. |
||
displayName |
string |
Отображаемое имя задачи. |
|
environmentSettings |
Список параметров переменных среды для задачи. |
||
exitConditions |
Указывает, как пакетная служба должна реагировать на выполнение задачи. |
||
multiInstanceSettings |
Объект , указывающий, что задача является задачей с несколькими экземплярами, и содержит сведения о том, как выполнить задачу с несколькими экземплярами. |
||
outputFiles |
Список файлов, которые пакетная служба будет отправлять с вычислительного узла после запуска командной строки. |
||
requiredSlots |
integer |
Количество слотов планирования, необходимых для выполнения задачи. |
|
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. |
||
userIdentity |
Удостоверение пользователя, под которым выполняется задача. |
Ответы
Имя | Тип | Описание |
---|---|---|
201 Created |
Запрос к пакетной службе выполнен успешно. Headers
|
|
Other Status Codes |
Ошибка пакетной службы. |
Безопасность
azure_auth
Microsoft Entra поток кода проверки подлинности OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
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=2023-11-01.18.0
{
"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=2023-11-01.18.0
{
"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=2023-11-01.18.0
{
"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=2023-11-01.18.0
{
"id": "task1",
"requiredSlots": 2,
"commandLine": "cmd /c echo task1"
}
Sample Response
Определения
Имя | Описание |
---|---|
Access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
Affinity |
Указание о локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором нужно запустить задачу. |
Application |
Ссылка на пакет, развертываемый на вычислительных узлах. |
Authentication |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
Auto |
область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе. |
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел. |
Container |
Частный реестр контейнеров. |
Container |
Расположение рабочего каталога задачи контейнера. |
Dependency |
Действие, выполняемое пакетной службой для задач, зависящих от этой задачи. |
Elevation |
Уровень повышения прав пользователя. |
Environment |
Переменная среды, задается в процессе задачи. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
Exit |
Как должна реагировать пакетная служба, если задача завершается с определенным кодом выхода. |
Exit |
Диапазон кодов выхода и способ реагирования пакетной службы на коды выхода в этом диапазоне. |
Exit |
Указывает, как пакетная служба должна реагировать на выполнение задачи. |
Exit |
Указывает, как пакетная служба реагирует на определенное условие выхода. |
Http |
Пара "имя-значение" заголовка HTTP |
Job |
Действие, выполняемое с заданием, содержащим задачу, если задача завершается с заданным условием выхода, а свойство задания onTaskFailed имеет значение "performExitOptionsJobAction". |
Multi |
Параметры, определяющие способ выполнения задачи с несколькими экземплярами. |
Output |
Спецификация для отправки файлов с вычислительного узла пакетная служба Azure в другое расположение после завершения выполнения задачи пакетной службой. |
Output |
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure. |
Output |
Назначение, в которое должен быть отправлен файл. |
Output |
Условия, при которых должен быть отправлен выходной файл задачи или набор файлов. |
Output |
Сведения об операции отправки выходного файла, включая условия для выполнения отправки. |
Resource |
Один файл или несколько файлов для скачивания на вычислительный узел. |
Task |
Добавляемая задача пакетная служба Azure. |
Task |
Ограничения выполнения, применяемые к задаче. |
Task |
Параметры контейнера для задачи. |
Task |
Указывает все зависимости задачи. Все задачи, явно указанные или находящиеся в диапазоне зависимостей, должны быть завершены до того, как будет запланировано выполнение зависимой задачи. |
Task |
Диапазон идентификаторов задач, от которые может зависеть задача. Все задачи с идентификаторами в диапазоне должны успешно завершиться, прежде чем можно будет запланировать зависимую задачу. |
User |
Определение удостоверения пользователя, с которым выполняется задача. |
AccessScope
Ресурсы пакетной службы, к которым маркер предоставляет доступ.
Имя | Тип | Описание |
---|---|---|
job |
string |
Предоставляет доступ для выполнения всех операций с заданием, содержащим задачу. |
AffinityInformation
Указание о локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором нужно запустить задачу.
Имя | Тип | Описание |
---|---|---|
affinityId |
string |
Непрозрачная строка, представляющая расположение вычислительного узла или задачи, которая выполнялась ранее. |
ApplicationPackageReference
Ссылка на пакет, развертываемый на вычислительных узлах.
Имя | Тип | Описание |
---|---|---|
applicationId |
string |
Идентификатор развертываемого приложения. |
version |
string |
Версия развертываемого приложения. Если этот параметр опущен, развертывается версия по умолчанию. |
AuthenticationTokenSettings
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы.
Имя | Тип | Описание |
---|---|---|
access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
AutoUserScope
область для автоматического пользователя
Имя | Тип | Описание |
---|---|---|
pool |
string |
Указывает, что задача выполняется как общая автоматическая учетная запись пользователя, созданная на каждом вычислительном узле в пуле. |
task |
string |
Указывает, что служба должна создать нового пользователя для задачи. |
AutoUserSpecification
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень прав автоматического пользователя. |
|
scope |
область для автоматического пользователя |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащих дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM для удостоверения, назначаемого пользователем. |
ContainerRegistry
Частный реестр контейнеров.
Имя | Тип | Описание |
---|---|---|
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. |
|
password |
string |
Пароль для входа на сервер реестра. |
registryServer |
string |
URL-адрес реестра. |
username |
string |
Имя пользователя для входа на сервер реестра. |
ContainerWorkingDirectory
Расположение рабочего каталога задачи контейнера.
Имя | Тип | Описание |
---|---|---|
containerImageDefault |
string |
Используйте рабочий каталог, определенный в образе контейнера. Помните, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой. |
taskWorkingDirectory |
string |
Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задачи, заполненные пакетной службой. |
DependencyAction
Действие, выполняемое пакетной службой для задач, зависящих от этой задачи.
Имя | Тип | Описание |
---|---|---|
block |
string |
Блокирует задачи, ожидающие выполнения этой задачи, не позволяя планировать их. |
satisfy |
string |
Выполнение задач, ожидающих этой задачи; Как только все зависимости будут выполнены, задача будет запланирована для выполнения. |
ElevationLevel
Уровень повышения прав пользователя.
Имя | Тип | Описание |
---|---|---|
admin |
string |
Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора. |
nonadmin |
string |
Пользователь является обычным пользователем без повышенных прав доступа. |
EnvironmentSetting
Переменная среды, задается в процессе задачи.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя переменной среды. |
value |
string |
Значение переменной среды. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |
ExitCodeMapping
Как должна реагировать пакетная служба, если задача завершается с определенным кодом выхода.
Имя | Тип | Описание |
---|---|---|
code |
integer |
Код завершения процесса. |
exitOptions |
Как должна реагировать пакетная служба, если задача завершает работу с этим кодом выхода. |
ExitCodeRangeMapping
Диапазон кодов выхода и способ реагирования пакетной службы на коды выхода в этом диапазоне.
Имя | Тип | Описание |
---|---|---|
end |
integer |
Последний код выхода в диапазоне. |
exitOptions |
Как должна реагировать пакетная служба, если задача завершается с кодом выхода в диапазоне от начала до конца (включительно). |
|
start |
integer |
Первый код выхода в диапазоне. |
ExitConditions
Указывает, как пакетная служба должна реагировать на выполнение задачи.
Имя | Тип | Описание |
---|---|---|
default |
Как должна реагировать пакетная служба в случае сбоя задачи с условием выхода, не охватываемым никакими другими свойствами. |
|
exitCodeRanges |
Список диапазонов кода выхода из задачи и способ реагирования пакетной службы на них. |
|
exitCodes |
Список отдельных кодов выхода из задачи и способов реагирования пакетной службы на них. |
|
fileUploadError |
Как должна реагировать пакетная служба в случае ошибки отправки файла. |
|
preProcessingError |
Как должна реагировать пакетная служба, если задача не запускается из-за ошибки. |
ExitOptions
Указывает, как пакетная служба реагирует на определенное условие выхода.
Имя | Тип | Описание |
---|---|---|
dependencyAction |
Действие, выполняемое пакетной службой для задач, зависящих от этой задачи. |
|
jobAction |
Действие, выполняемое с заданием, содержащим задачу, если задача завершается с заданным условием выхода, а свойство onTaskFailed задания имеет значение "performExitOptionsJobAction". |
HttpHeader
Пара "имя-значение" заголовка HTTP
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя заголовка без учета регистра, используемое при отправке выходных файлов |
value |
string |
Значение заголовка, используемого при отправке выходных файлов |
JobAction
Действие, выполняемое с заданием, содержащим задачу, если задача завершается с заданным условием выхода, а свойство задания onTaskFailed имеет значение "performExitOptionsJobAction".
Имя | Тип | Описание |
---|---|---|
disable |
string |
Отключите задание. Это эквивалентно вызову API задания отключения со значением disableTasks, равным requeue. |
none |
string |
Не предпринимать никаких действий. |
terminate |
string |
Завершите задание. Параметр terminateReason в параметре executionInfo задания имеет значение TaskFailed. |
MultiInstanceSettings
Параметры, определяющие способ выполнения задачи с несколькими экземплярами.
Имя | Тип | Описание |
---|---|---|
commonResourceFiles |
Список файлов, которые пакетная служба скачивает перед запуском командной строки координации. |
|
coordinationCommandLine |
string |
Командная строка, запускаемая на всех вычислительных узлах, чтобы они могли координировать выполнение команды main Task. |
numberOfInstances |
integer |
Количество вычислительных узлов, необходимых задаче. |
OutputFile
Спецификация для отправки файлов с вычислительного узла пакетная служба Azure в другое расположение после завершения выполнения задачи пакетной службой.
Имя | Тип | Описание |
---|---|---|
destination |
Назначение для выходных файлов. |
|
filePattern |
string |
Шаблон, указывающий, какие файлы следует отправить. |
uploadOptions |
Дополнительные параметры для операции отправки, включая условия для выполнения отправки. |
OutputFileBlobContainerDestination
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.
Имя | Тип | Описание |
---|---|---|
containerUrl |
string |
URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который отправляются файлы. |
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, указанному containerUrl. |
|
path |
string |
Целевой большой двоичный объект или виртуальный каталог в контейнере службы хранилища Azure. |
uploadHeaders |
Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов |
OutputFileDestination
Назначение, в которое должен быть отправлен файл.
Имя | Тип | Описание |
---|---|---|
container |
Расположение в хранилище BLOB-объектов Azure, в которое отправляются файлы. |
OutputFileUploadCondition
Условия, при которых должен быть отправлен выходной файл задачи или набор файлов.
Имя | Тип | Описание |
---|---|---|
taskcompletion |
string |
Отправьте файлы после завершения процесса задачи, независимо от того, какой код выхода был. |
taskfailure |
string |
Отправляйте файлы только после завершения процесса задачи с ненулевым кодом выхода. |
tasksuccess |
string |
Отправляйте файлы только после завершения процесса задачи с кодом выхода 0. |
OutputFileUploadOptions
Сведения об операции отправки выходного файла, включая условия для выполнения отправки.
Имя | Тип | Описание |
---|---|---|
uploadCondition |
Условия, при которых должен быть отправлен выходной файл задачи или набор файлов. |
ResourceFile
Один файл или несколько файлов для скачивания на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений файла в восьмеричном формате. |
filePath |
string |
Расположение на вычислительном узле, куда нужно скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес для скачивания файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, указанному storageContainerUrl или httpUrl. |
|
storageContainerUrl |
string |
URL-адрес контейнера BLOB-объектов в Хранилище BLOB-объектов Azure. |
TaskAddParameter
Добавляемая задача пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
affinityInfo |
Указание локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором будет запущена новая задача. |
|
applicationPackageReferences |
Список пакетов, которые пакетная служба будет развертывать на вычислительном узле перед запуском командной строки. |
|
authenticationTokenSettings |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
|
commandLine |
string |
Командная строка задачи. |
constraints |
Ограничения выполнения, применяемые к этой задаче. |
|
containerSettings |
Параметры контейнера, в котором выполняется задача. |
|
dependsOn |
Задачи, от которые зависит эта задача. |
|
displayName |
string |
Отображаемое имя задачи. |
environmentSettings |
Список параметров переменных среды для задачи. |
|
exitConditions |
Указывает, как пакетная служба должна реагировать на выполнение задачи. |
|
id |
string |
Строка, однозначно идентифицирующая задачу в задании. |
multiInstanceSettings |
Объект , указывающий, что задача является задачей с несколькими экземплярами, и содержит сведения о том, как выполнить задачу с несколькими экземплярами. |
|
outputFiles |
Список файлов, которые пакетная служба будет отправлять с вычислительного узла после запуска командной строки. |
|
requiredSlots |
integer |
Количество слотов планирования, необходимых для выполнения задачи. |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. |
|
userIdentity |
Удостоверение пользователя, под которым выполняется задача. |
TaskConstraints
Ограничения выполнения, применяемые к задаче.
Имя | Тип | Описание |
---|---|---|
maxTaskRetryCount |
integer |
Максимальное число повторных попыток задачи. Пакетная служба выполняет повторную попытку задачи, если ее код выхода не является нулевым. |
maxWallClockTime |
string |
Максимальное время, затраченное на выполнение задачи, отсчитываемое с момента запуска задачи. Если задача не завершена в течение предельного времени, пакетная служба завершает ее. |
retentionTime |
string |
Минимальное время хранения каталога задачи на вычислительном узле, где он запущен, с момента завершения выполнения. По истечении этого времени пакетная служба может удалить каталог задач и все его содержимое. |
TaskContainerSettings
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
TaskDependencies
Указывает все зависимости задачи. Все задачи, явно указанные или находящиеся в диапазоне зависимостей, должны быть завершены до того, как будет запланировано выполнение зависимой задачи.
Имя | Тип | Описание |
---|---|---|
taskIdRanges |
Список диапазонов идентификаторов задач, от которые зависит эта задача. Все задачи во всех диапазонах должны быть успешно завершены, прежде чем можно будет запланировать зависимую задачу. |
|
taskIds |
string[] |
Список идентификаторов задач, от которые зависит эта задача. Все задачи в этом списке должны быть успешно завершены, прежде чем можно будет запланировать зависимую задачу. |
TaskIdRange
Диапазон идентификаторов задач, от которые может зависеть задача. Все задачи с идентификаторами в диапазоне должны успешно завершиться, прежде чем можно будет запланировать зависимую задачу.
Имя | Тип | Описание |
---|---|---|
end |
integer |
Последний идентификатор задачи в диапазоне. |
start |
integer |
Первый идентификатор задачи в диапазоне. |
UserIdentity
Определение удостоверения пользователя, с которым выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, с которым выполняется задача. |