Task - Update

リファレンス

Service:: Batch Service

API Version:: 2023-11-01.18.0

指定した Task のプロパティを更新します。

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	すべてのAzure Batchサービス要求のベース URL。
jobId	path	True	string	タスクを含むジョブの ID。
taskId	path	True	string	更新するタスクの ID。
api-version	query	True	string	クライアント API のバージョン。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。

要求ヘッダー

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

名前	型	説明
client-request-id	string uuid	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない 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 サービスへの要求が成功しました。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

Batch サービスへの要求が成功しました。

Headers

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 認証コードフロー

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 Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
TaskConstraints	タスクに適用する実行制約。
TaskUpdateParameter	タスクに対して行われる変更のセット。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

ErrorMessage

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード
value	string	メッセージのテキストです。

TaskConstraints

タスクに適用する実行制約。

名前	型	説明
maxTaskRetryCount	integer	タスクを再試行できる最大回数。終了コードが 0 以外の場合、Batch サービスは Task を再試行します。この値は、0 以外の終了コードが原因で Task 実行可能ファイルの再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (最初の再試行が 1 回、再試行回数が 3 回)。最大再試行回数が 0 の場合、Batch サービスは最初の試行後にタスクを再試行しません。最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクやタスクには推奨されません。既定値は 0 (再試行なし) です。
maxWallClockTime	string	タスクが実行できる最大経過時間。タスクの開始時間から測定されます。タスクが制限時間内に完了しない場合は、Batch サービスによって終了されます。これを指定しない場合、タスクの実行時間に制限はありません。
retentionTime	string	実行が完了してから実行されたコンピューティングノード上の Task ディレクトリを保持する最小時間。この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。既定値は 7 日間です。つまり、コンピューティングノードが削除されるか、ジョブが削除されない限り、タスクディレクトリは 7 日間保持されます。

TaskUpdateParameter

タスクに対して行われる変更のセット。

名前	型	説明
constraints	TaskConstraints	このタスクに適用される制約。省略すると、タスクに既定の制約が与えられます。複数インスタンスのタスクの場合、保持時間の更新はプライマリタスクにのみ適用され、サブタスクには適用されません。

Share via

Task - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

Scopes

Authorization

例

Task update

Sample Request

Sample Response

定義

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

その他のリソース