Task - Update

Ссылка

Service:: Batch Service

API Version:: 2023-11-01.18.0

Обновления свойства указанной задачи.

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

With optional parameters:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?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 клиента.
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	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе не был изменен с указанного времени.

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

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

Имя	Тип	Описание
constraints	TaskConstraints	Ограничения, применяемые к этой задаче. Если этот параметр опущен, задаче присваивается ограничения по умолчанию. Для задач с несколькими экземплярами обновление времени хранения применяется только к основной задаче, но не к подзадачам.

Ответы

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

Имя

Тип

Описание

200 OK

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

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 update

Sample Request

HTTP

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



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Sample Response

Status code:: 200

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
TaskConstraints	Ограничения выполнения, применяемые к задаче.
TaskUpdateParameter	Набор изменений, которые необходимо вносить в задачу.

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

TaskConstraints

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

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

TaskUpdateParameter

Набор изменений, которые необходимо вносить в задачу.

Имя	Тип	Описание
constraints	TaskConstraints	Ограничения, применяемые к этой задаче. Если этот параметр опущен, задаче присваивается ограничения по умолчанию. Для задач с несколькими экземплярами обновление времени хранения применяется только к основной задаче, но не к подзадачам.

Task - Update

Параметры URI

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

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

Ответы

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

azure_auth

Scopes

Authorization

Примеры

Task update

Sample Request

Sample Response

Определения

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

Дополнительные ресурсы