Pool - Resize

リファレンス

サービス:: Batch Service

API バージョン:: 2024-07-01.20.0

プールに割り当てられているコンピューティングノードの数を変更します。
プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。プールのサイズを変更すると、プールの割り当ての状態が安定した状態からサイズ変更に変わります。自動スケーリング用に構成されているプールのサイズを変更することはできません。これを行おうとすると、Batch サービスからエラー 409 が返されます。プールのサイズを下方向に変更すると、削除するコンピューティングノードが Batch サービスによって選択されます。特定のコンピューティングノードを削除するには、代わりにプールのコンピューティングノードの削除 API を使用します。

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

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

POST {batchUrl}/pools/{poolId}/resize?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)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。

要求本文

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

名前	型	説明
nodeDeallocationOption	ComputeNodeDeallocationOption	プールのサイズが減少している場合にコンピューティングノードとその実行中のタスクを使用して何を行うかを決定します。既定値は requeue です。
resizeTimeout	string (duration)	プールへのノードの割り当てまたはプールからのコンピューティングノードの削除のタイムアウト。既定値は 15 分です。最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
targetDedicatedNodes	integer (int32)	プール内の専用コンピューティングノードの必要な数。
targetLowPriorityNodes	integer (int32)	プール内のスポット/優先順位の低いコンピューティングノードの目的の数。

応答

名前	型	説明
202 Accepted		Batch サービスへの要求が成功しました。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

202 Accepted

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

ヘッダー

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

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

Authorization

型: apiKey
/: header

例

Pool resize

要求のサンプル

HTTP

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2024-07-01.20.0



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

応答のサンプル

状態コード:: 202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
ComputeNodeDeallocationOption	割り当て解除を選択した後に、コンピューティングノードとその実行中のタスクを処理する方法を決定します。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
PoolResizeParameter	プールのサイズを変更するためのオプション。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ComputeNodeDeallocationOption

列挙

割り当て解除を選択した後に、コンピューティングノードとその実行中のタスクを処理する方法を決定します。

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

ErrorMessage

Object

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

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

PoolResizeParameter

Object

プールのサイズを変更するためのオプション。

名前	型	説明
nodeDeallocationOption	ComputeNodeDeallocationOption	プールのサイズが減少している場合にコンピューティングノードとその実行中のタスクを使用して何を行うかを決定します。既定値は requeue です。
resizeTimeout	string (duration)	プールへのノードの割り当てまたはプールからのコンピューティングノードの削除のタイムアウト。既定値は 15 分です。最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
targetDedicatedNodes	integer (int32)	プール内の専用コンピューティングノードの必要な数。
targetLowPriorityNodes	integer (int32)	プール内のスポット/優先順位の低いコンピューティングノードの目的の数。

次の方法で共有

Pool - Resize

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

Authorization

例

Pool resize

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

ComputeNodeDeallocationOption

ErrorMessage

PoolResizeParameter

その他のリソース