Pools - Delete Pool

サービス:: Batch Service

API バージョン:: 2025-06-01

指定したアカウントからプールを削除します。
プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティングノードに変更し始めます。既存のコンピューティングノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。その後、タスクは新しいプールで実行できます。再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラーコード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。

DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01

省略可能なパラメーターを含む:

DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01&timeOut={timeOut}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウントエンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
poolId	path	True	string	取得するプールの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

名前	型	説明
client-request-id	string	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string (date-time-rfc7231)	要求が発行された時刻。通常、クライアントライブラリはこれを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。
If-Modified-Since	string (date-time-rfc7231)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。
If-Unmodified-Since	string (date-time-rfc7231)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。
If-Match	string	クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。
If-None-Match	string	クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

名前

型

説明

202 Accepted

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

client-request-id: string
request-id: string

Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://batch.core.windows.net//.default

例

Pool delete

要求のサンプル

HTTP

DELETE {endpoint}/pools/poolId?api-version=2025-06-01

応答のサンプル

状態コード:: 202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

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

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