Pools - Enable Pool Auto Scale

サービス:

Batch Service

API バージョン:

2025-06-01

プールの自動スケーリングを有効にします。
プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。 同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。

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

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

POST {endpoint}/pools/{poolId}/enableautoscale?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より大きい場合は、デフォルトが使われます。」

要求ヘッダー

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 を直接呼び出す場合は、明示的に設定します。
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 がクライアントによって指定された値と一致しない場合にのみ実行されます。

要求本文

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

名前	型	説明
autoScaleEvaluationInterval	string (duration)	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 新しい間隔を指定すると、既存の自動スケール評価スケジュールは停止され、新しい自動スケール評価スケジュールが開始されます。その開始時刻はこのリクエストが発行された時刻です。 時間の長さはISO 8601形式で規定されています。
autoScaleFormula	string	プール内のコンピューティング ノードの目的の数の数式。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 新しい間隔を指定すると、既存の自動スケール評価スケジュールは停止され、新しい自動スケール評価スケジュールが開始されます。その開始時刻はこのリクエストが発行された時刻です。

応答

名前	型	説明
200 OK		要求は成功しました。 ヘッダー 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

例

Pool enable autoscale

要求のサンプル

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

応答のサンプル

状態コード:

200

定義

名前	説明
BatchError	Azure Batchサービスからエラー応答が届きました。
BatchErrorDetail	Azure Batchエラーレスポンスに含まれる追加情報項目。
BatchErrorMessage	Azure Batchのエラー応答でエラーメッセージが受信されました。
BatchPoolEnableAutoScaleOptions	Azure Batch Poolで自動スケーリングを有効にするパラメータ。

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

BatchPoolEnableAutoScaleOptions

Object

Azure Batch Poolで自動スケーリングを有効にするパラメータ。

名前	型	説明
autoScaleEvaluationInterval	string (duration)	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 新しい間隔を指定すると、既存の自動スケール評価スケジュールは停止され、新しい自動スケール評価スケジュールが開始されます。その開始時刻はこのリクエストが発行された時刻です。 時間の長さはISO 8601形式で規定されています。
autoScaleFormula	string	プール内のコンピューティング ノードの目的の数の数式。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 新しい間隔を指定すると、既存の自動スケール評価スケジュールは停止され、新しい自動スケール評価スケジュールが開始されます。その開始時刻はこのリクエストが発行された時刻です。