Nodes - Deallocate Node

サービス:: Batch Service

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

指定したコンピューティングノードの割り当てを解除します。
コンピューティングノードの割り当てを解除できるのは、アイドル状態または実行中の状態の場合のみです。

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/deallocate?api-version=2025-06-01

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

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/deallocate?api-version=2025-06-01&timeOut={timeOut}

URI パラメーター

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

要求ヘッダー

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

名前	型	説明
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 を直接呼び出す場合は、明示的に設定します。

要求本文

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

名前	型	説明
nodeDeallocateOption	BatchNodeDeallocateOption	コンピューティングノードの割り当てを解除するタイミングと、現在実行中のタスクの処理。既定値は requeue です。

応答

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

名前

型

説明

202 Accepted

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

ヘッダー

DataServiceId: string
ETag: string
Last-Modified: string
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

例

Node Deallocate

要求のサンプル

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/deallocate?api-version=2025-06-01

応答のサンプル

状態コード:: 202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
BatchNodeDeallocateOption	BatchNodeDeallocateOption enums
BatchNodeDeallocateOptions	コンピューティングノードの割り当てを解除するためのオプション。

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

BatchNodeDeallocateOption

列挙

BatchNodeDeallocateOption enums

値	説明
requeue	実行中のタスクプロセスを終了し、タスクを再キューします。コンピューティングノードが使用可能になると、タスクが再度実行されます。タスクが終了したらすぐにコンピューティングノードの割り当てを解除します。
terminate	実行中のタスクを終了します。タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。タスクが終了したらすぐにコンピューティングノードの割り当てを解除します。
taskcompletion	現在実行中のタスクの完了を許可します。待機中に新しいタスクをスケジュールしません。すべてのタスクが完了したら、コンピューティングノードの割り当てを解除します。
retaineddata	非推奨になりましたが、タスクの Azure Storage にタスクデータをアップロードし、代わりに `TaskCompletion` を使用することをお勧めします。現在実行中のタスクの完了を許可し、すべてのタスクデータ保有期間の有効期限が切れるのを待ちます。待機中に新しいタスクをスケジュールしません。すべてのタスク保有期間の有効期限が切れたときに、コンピューティングノードの割り当てを解除します。

BatchNodeDeallocateOptions

Object

コンピューティングノードの割り当てを解除するためのオプション。

名前	型	説明
nodeDeallocateOption	BatchNodeDeallocateOption	コンピューティングノードの割り当てを解除するタイミングと、現在実行中のタスクの処理。既定値は requeue です。

次の方法で共有

Nodes - Deallocate Node

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

OAuth2Auth

スコープ

例

Node Deallocate

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeDeallocateOption

BatchNodeDeallocateOptions