Pool - Delete

サービス:

Batch Service

API バージョン:

2024-07-01.20.0

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

DELETE {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0

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

DELETE {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
poolId	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)	呼び出し元によって生成された要求 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)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。

応答

名前	型	説明
202 Accepted		Batch サービスへの要求が成功しました。 ヘッダー client-request-id: string request-id: string
Other Status Codes	BatchError	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

例

Pool delete

要求のサンプル

HTTP

DELETE account.region.batch.azure.com/pools/poolId?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

202

定義

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

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	メッセージのテキスト。