你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	所有 Azure Batch 服务请求的基本 URL。
jobId	path	True	string	包含任务的作业的 ID。
taskId	path	True	string	要更新的任务的 ID。
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		对 Batch 服务的请求成功。标头 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 服务中的错误。

名称

类型

说明

200 OK

对 Batch 服务的请求成功。

标头

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: 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 Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
ErrorMessage	Azure Batch 错误响应中收到的错误消息。
TaskConstraints	要应用于任务的执行约束。
TaskUpdateParameter	要对任务进行的更改集。

BatchError

Object

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Object

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

ErrorMessage

Object

Azure Batch 错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。

TaskConstraints

Object

要应用于任务的执行约束。

名称	类型	说明
maxTaskRetryCount	integer (int32)	可以重试任务的最大次数。如果 Batch 服务退出代码为非零，则重试任务。请注意，由于非零退出代码，此值专门控制任务可执行文件的重试次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。如果最大重试计数为 0，则 Batch 服务不会在第一次尝试后重试任务。如果最大重试计数为 -1，Batch 服务将重试任务，但不建议用于启动任务或任何任务。默认值为 0（无重试）。
maxWallClockTime	string (duration)	任务可能运行的最大运行时间，从任务开始时间开始测量。如果任务未在时间限制内完成，Batch 服务将终止它。如果未指定此项，则任务可能运行的时间没有时间限制。
retentionTime	string (duration)	在运行任务的计算节点上保留任务目录的最短时间，从其完成执行时开始。之后，Batch 服务可能会删除 Task 目录及其所有内容。默认值为 7 天，即任务目录将保留 7 天，除非删除计算节点或删除作业。

TaskUpdateParameter

Object

要对任务进行的更改集。

名称	类型	说明
constraints	TaskConstraints	适用于此任务的约束。如果省略，则为任务提供默认约束。对于多实例任务，更新保留时间仅适用于主任务，不适用于子任务。

通过

Task - Update

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

Authorization

示例

Task update

示例请求

示例响应

定义

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

其他资源