Task - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Возвращает сведения об указанной задаче.
Для задач с несколькими экземплярами такие сведения, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API подзадач списка для получения сведений о подзадачах.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех пакетная служба Azure запросов на обслуживание.
jobId	path	True	string	Идентификатор задания, содержащего задачу.
taskId	path	True	string	Идентификатор задачи для получения сведений.
api-version	query	True	string	Версия API клиента.
$expand	query		string	Предложение $expand OData.
$select	query		string	Предложение OData $select.
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 напрямую.
If-Match		string	Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match		string	Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
If-Modified-Since		string date-time-rfc1123	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс службы был изменен с указанного времени.
If-Unmodified-Since		string date-time-rfc1123	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе не изменялся с указанного времени.

Ответы

Имя	Тип	Описание
200 OK	CloudTask	Ответ, содержащий задачу. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

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

Примеры

Task get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Определения

Имя	Описание
AccessScope	Ресурсы пакетной службы, к которым маркер предоставляет доступ.
AffinityInformation	Указание локальности, которое может использоваться пакетной службой для выбора вычислительного узла, на котором запускается задача.
ApplicationPackageReference	Ссылка на пакет, развертываемый на вычислительных узлах.
AuthenticationTokenSettings	Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы.
AutoUserScope	область для автоматического пользователя
AutoUserSpecification	Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе.
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure.
CloudTask	Задача пакетная служба Azure.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом.
ComputeNodeInformation	Сведения о вычислительном узле, на котором выполняется задача.
ContainerRegistry	Частный реестр контейнеров.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
DependencyAction	Действие, выполняемое пакетной службой с задачами, которые зависят от этой задачи.
ElevationLevel	Уровень прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorCategory	Категория ошибки.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
ExitCodeMapping	Как должна реагировать пакетная служба, если задача завершается с определенным кодом выхода.
ExitCodeRangeMapping	Диапазон кодов выхода и способ реагирования пакетной службы на коды выхода в этом диапазоне.
ExitConditions	Указывает, как пакетная служба должна реагировать на выполнение задачи.
ExitOptions	Указывает, как пакетная служба реагирует на определенное условие выхода.
HttpHeader	Пара "имя-значение" заголовка HTTP
JobAction	Действие, выполняемое с заданием, содержащим задачу, если задача завершается с заданным условием выхода, а свойство onTaskFailed задания имеет значение "performExitOptionsJobAction".
MultiInstanceSettings	Параметры, определяющие способ запуска задачи с несколькими экземплярами.
NameValuePair	Представляет пару "имя-значение".
OutputFile	Спецификация для отправки файлов из вычислительного узла пакетная служба Azure в другое расположение после того, как пакетная служба завершит выполнение процесса задачи.
OutputFileBlobContainerDestination	Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.
OutputFileDestination	Место назначения, в которое должен быть отправлен файл.
OutputFileUploadCondition	Условия, при которых должен отправляться выходной файл задачи или набор файлов.
OutputFileUploadOptions	Сведения об операции отправки выходных файлов, в том числе о том, при каких условиях следует выполнить отправку.
ResourceFile	Один файл или несколько файлов для загрузки на вычислительный узел.
TaskConstraints	Ограничения выполнения, применяемые к задаче.
TaskContainerExecutionInformation	Содержит сведения о контейнере, который выполняет задача.
TaskContainerSettings	Параметры контейнера для задачи.
TaskDependencies	Указывает все зависимости задачи. Все задачи, явно указанные или находящиеся в диапазоне зависимостей, должны быть завершены до того, как будет запланировано выполнение зависимой задачи.
TaskExecutionInformation	Сведения о выполнении задачи.
TaskExecutionResult	Результат выполнения задачи.
TaskFailureInformation	Сведения о сбое задачи.
TaskIdRange	Диапазон идентификаторов задач, от которые может зависеть задача. Все задачи с идентификаторами в диапазоне должны успешно завершиться, прежде чем можно будет запланировать зависимую задачу.
TaskState	Состояние задачи.
TaskStatistics	Статистика использования ресурсов для задачи.
UserIdentity	Определение удостоверения пользователя, с которым выполняется задача.

AccessScope

Ресурсы пакетной службы, к которым маркер предоставляет доступ.

Имя	Тип	Описание
job	string	Предоставляет доступ для выполнения всех операций с заданием, содержащим задачу.

AffinityInformation

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

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

ApplicationPackageReference

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

Имя	Тип	Описание
applicationId	string	Идентификатор развертываемого приложения. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Версия развертываемого приложения. Если этот параметр опущен, развертывается версия по умолчанию. Если этот параметр не указан в пуле и для этого приложения не указана версия по умолчанию, запрос завершается ошибкой с кодом ошибки InvalidApplicationPackageReferences и кодом состояния HTTP 409. Если этот параметр опущен в задаче и для этого приложения не указана версия по умолчанию, задача завершается ошибкой предварительной обработки.

AuthenticationTokenSettings

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

Имя	Тип	Описание
access	AccessScope[]	Ресурсы пакетной службы, к которым маркер предоставляет доступ. Маркер проверки подлинности предоставляет доступ к ограниченному набору операций пакетной службы. В настоящее время единственным поддерживаемым значением для свойства доступа является job, которое предоставляет доступ ко всем операциям, связанным с заданием, содержащим задачу.

AutoUserScope

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

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

AutoUserSpecification

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

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень прав автоматического пользователя. Значение по умолчанию — nonAdmin.
scope	AutoUserScope	область для автоматического пользователя Значение по умолчанию — pool. Если пул работает под управлением Windows, следует указать значение Task, если требуется более строгая изоляция между задачами. Например, если задача изменяет реестр таким образом, что может повлиять на другие задачи, или если в пуле указаны сертификаты, которые не должны быть доступны обычным задачам, но должны быть доступны startTasks.

BatchError

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	ErrorMessage	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ об ошибке.

CloudTask

Задача пакетная служба Azure.

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

ComputeNodeIdentityReference

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

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

ComputeNodeInformation

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

Имя	Тип	Описание
affinityId	string	Идентификатор узла, на котором выполнялась задача, который можно передать при добавлении задачи для запроса на планирование задачи на этом вычислительном узле.
nodeId	string	Идентификатор вычислительного узла, на котором выполнялась задача.
nodeUrl	string	URL-адрес вычислительного узла, на котором выполнялась задача.
poolId	string	Идентификатор пула, в котором выполнялась задача.
taskRootDirectory	string	Корневой каталог задачи на вычислительном узле.
taskRootDirectoryUrl	string	URL-адрес корневого каталога задачи на вычислительном узле.

ContainerRegistry

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

Имя	Тип	Описание
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом.
password	string	Пароль для входа на сервер реестра.
registryServer	string	URL-адрес реестра. Если этот параметр опущен, значение по умолчанию — "docker.io".
username	string	Имя пользователя для входа на сервер реестра.

ContainerWorkingDirectory

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

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

DependencyAction

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

Имя	Тип	Описание
block	string	Блокирует задачи, ожидающие этой задачи, предотвращая их планирование.
satisfy	string	Выполнение задач, ожидающих этой задачи; После выполнения всех зависимостей задача будет запланирована на выполнение.

ElevationLevel

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

Имя	Тип	Описание
admin	string	Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора.
nonadmin	string	Пользователь является обычным пользователем без повышенных прав доступа.

EnvironmentSetting

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

Имя	Тип	Описание
name	string	Имя переменной среды.
value	string	Значение переменной среды.

ErrorCategory

Категория ошибки.

Имя	Тип	Описание
servererror	string	Ошибка связана с внутренней проблемой сервера.
usererror	string	Ошибка связана с проблемой пользователя, например неправильной настройкой.

ErrorMessage

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

Имя	Тип	Описание
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

ExitCodeMapping

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

Имя	Тип	Описание
code	integer	Код завершения процесса.
exitOptions	ExitOptions	Как должна реагировать пакетная служба, если задача завершает работу с этим кодом выхода.

ExitCodeRangeMapping

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

Имя	Тип	Описание
end	integer	Последний код выхода в диапазоне.
exitOptions	ExitOptions	Как должна реагировать пакетная служба, если задача завершается с кодом выхода в диапазоне от начала до конца (включительно).
start	integer	Первый код выхода в диапазоне.

ExitConditions

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

Имя	Тип	Описание
default	ExitOptions	Как должна реагировать пакетная служба в случае сбоя задачи с условием выхода, не охватываемым никакими другими свойствами. Это значение используется, если задача завершается с любым ненулевым кодом выхода, не указанным в коллекции exitCodes или exitCodeRanges, с ошибкой предварительной обработки, если свойство preProcessingError отсутствует, или с ошибкой отправки файла, если свойство fileUploadError отсутствует. Если требуется поведение не по умолчанию для кода выхода 0, необходимо явно перечислить его с помощью коллекции exitCodes или exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Список диапазонов кода выхода из задачи и способ реагирования пакетной службы на них.
exitCodes	ExitCodeMapping[]	Список отдельных кодов выхода из задачи и способов реагирования пакетной службы на них.
fileUploadError	ExitOptions	Как должна реагировать пакетная служба в случае ошибки отправки файла. Если задача завершилась с кодом выхода, указанным с помощью exitCodes или exitCodeRanges, а затем обнаружила ошибку отправки файла, то действие, указанное в коде выхода, имеет приоритет.
preProcessingError	ExitOptions	Как должна реагировать пакетная служба, если задача не запускается из-за ошибки.

ExitOptions

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

Имя	Тип	Описание
dependencyAction	DependencyAction	Действие, выполняемое пакетной службой с задачами, которые зависят от этой задачи. Возможные значения: "удовлетворяет" (позволяет выполнять зависимые задачи) и "блокировать" (зависимые задачи продолжают ждать). Пакетная служба пока не поддерживает отмену зависимых задач.
jobAction	JobAction	Действие, выполняемое с заданием, содержащим задачу, если задача завершается с заданным условием выхода, а свойство onTaskFailed задания имеет значение "performExitOptionsJobAction". Значение по умолчанию равно none для кода выхода 0 и terminate для всех остальных условий выхода. Если свойство onTaskFailed задания имеет значение noaction, то при указании этого свойства возвращается ошибка, а запрос на добавление задачи завершается ошибкой с ошибкой недопустимого значения свойства. Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

HttpHeader

Пара "имя-значение" заголовка HTTP

Имя	Тип	Описание
name	string	Имя заголовка без учета регистра, которое будет использоваться при отправке выходных файлов
value	string	Значение заголовка, используемого при отправке выходных файлов

JobAction

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

Имя	Тип	Описание
disable	string	Отключите задание. Это эквивалентно вызову API заданий disable со значением disableTasks requeue.
none	string	Не предпринимать никаких действий.
terminate	string	Завершите задание. Параметр terminateReason в executionInfo задания имеет значение TaskFailed.

MultiInstanceSettings

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

Имя	Тип	Описание
commonResourceFiles	ResourceFile[]	Список файлов, которые пакетная служба скачивает перед запуском командной строки координации. Разница между общими файлами ресурсов и файлами ресурсов задачи заключается в том, что общие файлы ресурсов скачиваются для всех подзадач, включая основную, а файлы ресурсов задачи — только для основной. Также обратите внимание, что эти файлы ресурсов не скачиваются в рабочий каталог Task, а скачиваются в корневой каталог задачи (один каталог выше рабочего каталога). Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
coordinationCommandLine	string	Командная строка, запускаемая на всех вычислительных узлах, чтобы обеспечить их координацию при выполнении основной команды main Task. Типичная командная строка координации запускает фоновую службу и проверяет готовность службы к обработке сообщений между узлами.
numberOfInstances	integer	Количество вычислительных узлов, необходимых задаче. Если этот параметр опущен, значение по умолчанию равно 1.

NameValuePair

Представляет пару "имя-значение".

Имя	Тип	Описание
name	string	Имя в паре "имя-значение".
value	string	Значение в паре имя-значение.

OutputFile

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

Имя	Тип	Описание
destination	OutputFileDestination	Назначение для выходных файлов.
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	OutputFileUploadOptions	Дополнительные параметры для операции отправки, включая условия для выполнения отправки.

OutputFileBlobContainerDestination

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

Имя	Тип	Описание
containerUrl	string	URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который отправляются файлы. Если управляемое удостоверение не используется, URL-адрес должен содержать подписанный URL-адрес (SAS), предоставляющий разрешения на запись в контейнер.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданное containerUrl. Удостоверение должно иметь доступ на запись в контейнер Хранилище BLOB-объектов Azure
path	string	Целевой большой двоичный объект или виртуальный каталог в контейнере службы хранилища Azure. Если filePattern ссылается на конкретный файл (т. е. не содержит подстановочных знаков), то путь — это имя большого двоичного объекта, в который нужно отправить этот файл. Если filePattern содержит один или несколько подстановочных знаков (и, следовательно, может соответствовать нескольким файлам), то путь — это имя виртуального каталога BLOB-объекта (который добавляется к имени каждого большого двоичного объекта), в который нужно отправить файлы. Если этот параметр опущен, файлы отправляются в корень контейнера с именем большого двоичного объекта, соответствующим их имени.
uploadHeaders	HttpHeader[]	Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов Эти заголовки будут указаны при отправке файлов в службу хранилища Azure. Официальный документ о разрешенных заголовках при отправке больших двоичных объектов: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

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

Имя	Тип	Описание
container	OutputFileBlobContainerDestination	Расположение в хранилище BLOB-объектов Azure, в которое отправляются файлы.

OutputFileUploadCondition

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

Имя	Тип	Описание
taskcompletion	string	Отправьте файлы после завершения процесса задачи, независимо от того, какой код выхода был.
taskfailure	string	Отправляйте файлы только после завершения процесса задачи с ненулевым кодом выхода.
tasksuccess	string	Отправляйте файлы только после завершения процесса задачи с кодом выхода 0.

OutputFileUploadOptions

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

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

ResourceFile

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

Имя	Тип	Описание
autoStorageContainerName	string	Имя контейнера хранилища в учетной записи автоматического хранения. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны.
blobPrefix	string	Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. Свойство допустимо только при использовании autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, будут загружены все файлы в контейнере.
fileMode	string	Атрибут режима разрешений для файлов в восьмеричном формате. Это свойство применяется только к файлам, загружаемым на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на вычислительный узел Windows. Если это свойство не указано для вычислительного узла Linux, к файлу применяется значение по умолчанию 0770.
filePath	string	Расположение на вычислительном узле, в который нужно скачать файлы, относительно рабочего каталога задачи. Если указано свойство httpUrl, filePath является обязательным и описывает путь, по которому будет скачан файл, включая имя файла. В противном случае, если указано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет полностью сохранена и добавлена в указанный каталог filePath. Указанный относительный путь не может вырваться из рабочего каталога задачи (например, с помощью ..).
httpUrl	string	URL-адрес для скачивания файла. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Если URL-адрес указывает на Хранилище BLOB-объектов Azure, он должен быть читаемым с вычислительных узлов. Существует три способа получить такой URL-адрес для BLOB-объекта в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общий доступ.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к Хранилище BLOB-объектов Azure, указанное storageContainerUrl или httpUrl. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом.
storageContainerUrl	string	URL-адрес контейнера больших двоичных объектов в Хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Этот URL-адрес должен быть удобочитаемым и содержать список из вычислительных узлов. Существует три способа получить такой URL-адрес для контейнера в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и перечисление в контейнере, использовать управляемое удостоверение с разрешениями на чтение и перечисление или задать список ACL для контейнера, чтобы разрешить общий доступ.

TaskConstraints

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

Имя	Тип	Описание
maxTaskRetryCount	integer	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если ее код выхода не равен нулю. Обратите внимание, что это значение определяет количество повторных попыток для исполняемого файла задачи из-за ненулевого кода выхода. Пакетная служба попытается выполнить задачу один раз, а затем может повторить попытку до этого предела. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу после первой попытки. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничений, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток).
maxWallClockTime	string	Максимальное затраченное время выполнения задачи, измеряемое с момента запуска задачи. Если задача не завершается в течение предельного времени, пакетная служба завершает ее. Если этот параметр не указан, срок выполнения задачи не ограничен.
retentionTime	string	Минимальное время хранения каталога задачи на вычислительном узле, где он запущен, с момента завершения выполнения. По истечении этого времени пакетная служба может удалить каталог Задач и все его содержимое. Значение по умолчанию — 7 дней, т. е. каталог задач будет храниться в течение 7 дней, если вычислительный узел не будет удален или задание не будет удалено.

TaskContainerExecutionInformation

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

Имя	Тип	Описание
containerId	string	Идентификатор контейнера.
error	string	Подробные сведения об ошибке о контейнере. Это подробная строка ошибки из службы Docker, если она доступна. Это эквивалентно полю ошибки, возвращаемой docker inspect.
state	string	Состояние контейнера. Это состояние контейнера в соответствии со службой Docker. Это эквивалентно полю состояния, возвращаемого docker inspect.

TaskContainerSettings

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

Имя	Тип	Описание
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов для команды docker create в дополнение к тем, которые управляются пакетной службой.
imageName	string	Образ, используемый для создания контейнера, в котором будет выполняться задача. Это полная ссылка на образ, указанная для docker pull. Если в имени образа не указан тег , по умолчанию используется тег ":latest".
registry	ContainerRegistry	Частный реестр, содержащий образ контейнера. Этот параметр можно опустить, если он уже был указан при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера. Значение по умолчанию — taskWorkingDirectory.

TaskDependencies

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

Имя	Тип	Описание
taskIdRanges	TaskIdRange[]	Список диапазонов идентификаторов задач, от которые зависит эта задача. Все задачи во всех диапазонах должны быть успешно завершены, прежде чем можно будет запланировать зависимую задачу.
taskIds	string[]	Список идентификаторов задач, от которые зависит эта задача. Все задачи в этом списке должны быть успешно завершены, прежде чем можно будет запланировать зависимую задачу. Общая длина коллекции taskIds ограничена 64000 символами (т. е. общая длина всех идентификаторов задач). Если коллекция taskIds превышает максимальную длину, запрос на добавление задачи завершается ошибкой с кодом TaskDependencyListTooLong. В этом случае рекомендуется использовать диапазоны идентификаторов задач.

TaskExecutionInformation

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

Имя	Тип	Описание
containerInfo	TaskContainerExecutionInformation	Сведения о контейнере, в котором выполняется задача. Это свойство задается, только если задача выполняется в контексте контейнера.
endTime	string	Время завершения задачи. Это свойство задается, только если задача находится в состоянии Завершено.
exitCode	integer	Код выхода программы, указанной в командной строке Задачи. Это свойство задается, только если задача находится в состоянии завершения. Как правило, код выхода для процесса отражает конкретное соглашение, реализованное разработчиком приложения для этого процесса. Если вы используете значение кода выхода для принятия решений в коде, убедитесь, что известно соглашение о коде выхода, используемое процессом приложения. Однако если пакетная служба завершает задачу (из-за истечения времени ожидания или завершения работы пользователя через API), может отображаться определенный операционной системой код выхода.
failureInfo	TaskFailureInformation	Сведения, описывающие сбой задачи, если таковые есть. Это свойство задается только в том случае, если задача находится в состоянии завершения и возникла ошибка.
lastRequeueTime	string	Самое последнее время, когда пакетная служба перезапросила задачу в результате запроса пользователя. Это свойство задается, только если requeueCount не равно нулю.
lastRetryTime	string	Самое последнее время, когда началась повторная попытка задачи. Этот элемент присутствует только в том случае, если задача была повторна (т. е. retryCount не равно нулю). При наличии обычно это значение совпадает с startTime, но может отличаться, если задача была перезапущена по причинам, отличным от повторных попыток. Например, если вычислительный узел был перезагружен во время повторных попыток, то startTime обновляется, а lastRetryTime — нет.
requeueCount	integer	Количество повторных вызовов задачи пакетной службой в результате запроса пользователя. Когда пользователь удаляет вычислительные узлы из пула (путем изменения размера или сжатия пула) или при отключении задания пользователь может указать, что выполняющиеся задачи на вычислительных узлах должны быть перезапрослены для выполнения. Этот счетчик отслеживает, сколько раз задача была повторно поставлена в очередь по этим причинам.
result	TaskExecutionResult	Результат выполнения задачи. Если значение равно failed, подробные сведения о сбое можно найти в свойстве failureInfo.
retryCount	integer	Количество повторных попыток выполнения задачи пакетной службой. Сбои приложения задачи (ненулевой код выхода) повторяются, ошибки предварительной обработки (не удалось выполнить задачу) и ошибки отправки файлов не повторяются. Пакетная служба повторит задачу до предела, указанного ограничениями.
startTime	string	Время запуска задачи. "Выполняется" соответствует состоянию выполнения, поэтому, если в задаче указаны файлы ресурсов или пакеты, то время начала отражает время, когда задача начала скачивать или развертывать их. Если задача была перезапущена или повторна, это самый последний момент запуска задачи. Это свойство присутствует только для задач, которые находятся в состоянии выполнения или завершения.

TaskExecutionResult

Результат выполнения задачи.

Имя	Тип	Описание
failure	string	Во время обработки задачи произошла ошибка. Возможно, сбой произошел до запуска процесса задачи, во время выполнения процесса задачи или после завершения процесса задачи.
success	string	Задача успешно выполнена.

TaskFailureInformation

Сведения о сбое задачи.

Имя	Тип	Описание
category	ErrorCategory	Категория ошибки задачи.
code	string	Идентификатор ошибки задачи. Коды инвариантны и предназначены для программного использования.
details	NameValuePair[]	Список дополнительных сведений, связанных с ошибкой.
message	string	Сообщение, описывающее ошибку задачи, предназначенную для отображения в пользовательском интерфейсе.

TaskIdRange

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

Имя	Тип	Описание
end	integer	Последний идентификатор задачи в диапазоне.
start	integer	Первый идентификатор задачи в диапазоне.

TaskState

Состояние задачи.

Имя	Тип	Описание
active	string	Задача находится в очереди и может выполняться, но в настоящее время не назначена вычислительному узлу. Задача переходит в это состояние при создании, при включении после отключения или при ожидании повторных попыток после неудачного выполнения.
completed	string	Задача больше не может выполняться, как правило, из-за успешного завершения задачи или из-за неудачного завершения задачи и исчерпания лимита повторных попыток. Задача также помечается как завершенная, если произошла ошибка при запуске задачи или когда задача была завершена.
preparing	string	Задача назначена вычислительному узлу, но ожидает завершения необходимой задачи подготовки задания на вычислительном узле. Если задача подготовки задания будет выполнена успешно, задача перейдет к выполнению. Если задача подготовки задания завершается сбоем, задача вернется к активной и может быть назначена другому вычислительному узлу.
running	string	Задача выполняется на вычислительном узле. Сюда входит подготовка на уровне задачи, например скачивание файлов ресурсов или развертывание пакетов, указанных в задаче. Это не обязательно означает, что командная строка задачи запущена.

TaskStatistics

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

Имя	Тип	Описание
kernelCPUTime	string	Общее время ЦП в режиме ядра (суммарное для всех ядер и всех вычислительных узлов), затраченное задачей.
lastUpdateTime	string	Время последнего обновления статистики. Вся статистика ограничена диапазоном между startTime и lastUpdateTime.
readIOGiB	number	Общее число гибибайт, считанных с диска задачей.
readIOps	integer	Общее количество операций чтения на диске, выполненных задачей.
startTime	string	Время начала диапазона времени, охватываемого статистикой.
url	string	URL-адрес статистики.
userCPUTime	string	Общее время ЦП в пользовательском режиме (суммарное для всех ядер и всех вычислительных узлов), затраченное задачей.
waitTime	string	Общее время ожидания задачи. Время ожидания задачи определяется как время, прошедшее между созданием задачи и началом ее выполнения. (Если задача выполняется повторно из-за сбоев, время ожидания — это время последнего выполнения задачи.)
wallClockTime	string	Общее время выполнения задачи. Настенное время — это время, затраченное с момента запуска задачи на вычислительном узле до момента ее завершения (или до последнего обновления статистики, если задача не была завершена к тому времени). Если задача была повторна, это включает в себя время настенных часов всех повторных попыток задачи.
writeIOGiB	number	Общее количество гибибайт, записанных на диск задачей.
writeIOps	integer	Общее количество операций записи на диск, выполненных задачей.

UserIdentity

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

Имя	Тип	Описание
autoUser	AutoUserSpecification	Автоматический пользователь, под которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; Необходимо указать один, но не оба.
username	string	Имя удостоверения пользователя, с которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; Необходимо указать один, но не оба.