Task - Delete
指定したジョブからタスクを削除します。
タスクが削除されると、実行されたコンピューティング ノード上のディレクトリ内のすべてのファイルも削除されます (保持時間に関係なく)。 複数インスタンスのタスクの場合、タスクの削除操作はプライマリ タスクに同期的に適用されます。サブタスクとそのファイルは、バックグラウンドで非同期的に削除されます。
DELETE {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0
DELETE {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2023-11-01.18.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
path | True |
string |
すべてのAzure Batchサービス要求のベース URL。 |
job
|
path | True |
string |
タスクを削除するジョブの ID。 |
task
|
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 |
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 操作は、指定された時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Batch サービスへの要求が成功しました。 ヘッダー
|
|
Other Status Codes |
Batch サービスからのエラー。 |
セキュリティ
azure_auth
Microsoft Entra OAuth 2.0 認証コード フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
Authorization
型:
apiKey
/:
header
例
Task delete
要求のサンプル
DELETE account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0
応答のサンプル
定義
名前 | 説明 |
---|---|
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batchエラー応答に含まれる追加情報の項目。 |
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
BatchError
Azure Batch サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batchエラー応答に含まれる追加情報の項目。
名前 | 型 | 説明 |
---|---|---|
key |
string |
Value プロパティの意味を指定する識別子。 |
value |
string |
エラー応答に含まれる追加情報。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
string |
エラー メッセージの言語コード |
value |
string |
メッセージのテキストです。 |