Task - Update

Ссылка

Служба:: Batch Service

Версия API:: 2024-07-01.20.0

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

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

С использованием необязательных параметров:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.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 секунд. Если значение больше 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		Запрос к пакетной службе выполнен успешно. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

Имя

Тип

Описание

200 OK

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

Заголовки

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Task update

Образец запроса

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



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

Пример ответа

Код состояния:: 200

Определения

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

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ErrorMessage

Object

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

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

TaskConstraints

Object

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

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

TaskUpdateParameter

Object

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

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

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

Task - Update

Параметры URI

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

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

Ответы

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

azure_auth

Области

Authorization

Примеры

Task update

Образец запроса

Пример ответа

Определения

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

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