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 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
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"

名稱	類型	Description
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"

名稱	類型	Description
constraints	TaskConstraints	套用至此工作的條件約束。如果省略，則會將工作指定為默認條件約束。針對多重實例工作，更新保留時間僅適用於主要工作，而不是子工作。

回應

名稱	類型	Description
200 OK		Batch 服務的要求成功。標題 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 服務的錯誤。

名稱

類型

Description

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
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
TaskConstraints	要套用至工作的執行條件約束。
TaskUpdateParameter	要對工作進行的一組變更。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。

TaskConstraints

要套用至工作的執行條件約束。

名稱	類型	Description
maxTaskRetryCount	integer	重試工作的最大次數。如果 Batch 服務結束代碼為非零，則會重試工作。請注意，這個值會特別控制工作可執行檔的重試次數，因為非零結束代碼。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。如果重試計數上限為0，Batch服務就不會在第一次嘗試之後重試工作。如果重試計數上限為 -1，Batch 服務會不限制地重試工作，但不建議用於啟動工作或任何工作。預設值為 0（沒有重試）。
maxWallClockTime	string	工作可能執行的最大經過時間，從工作開始的時間測量。如果工作未在時間限制內完成，Batch 服務就會終止它。如果未指定此專案，則工作執行的時間長度沒有限制。
retentionTime	string	從執行完成時起，在計算節點上保留工作目錄的時間下限。在這段時間之後，Batch 服務可能會刪除Task目錄及其所有內容。默認值為 7 天，也就是工作目錄將保留 7 天，除非移除計算節點或刪除作業。

TaskUpdateParameter

要對工作進行的一組變更。

名稱	類型	Description
constraints	TaskConstraints	套用至此工作的條件約束。如果省略，則會將工作指定為默認條件約束。針對多重實例工作，更新保留時間僅適用於主要工作，而不是子工作。

共用方式為

Task - Update

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

Authorization

範例

Task update

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

其他資源