次の方法で共有

Pool - Stop Resize

  • リファレンス
サービス:
Batch Service
API バージョン:
2024-07-01.20.0

プールで進行中のサイズ変更操作を停止します。
これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更が停止されるだけで、プールは現在の状態を維持します。 停止後、プールは停止操作が完了した時点のコンピューティング ノードの数で安定します。 停止操作中、プール割り当ての状態は最初に停止状態に変わり、次に安定状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API は、作成時にプールの初期サイズ設定を停止するためにも使用できます。

POST {batchUrl}/pools/{poolId}/stopresize?api-version=2024-07-01.20.0
省略可能なパラメーターを含む: 
POST {batchUrl}/pools/{poolId}/stopresize?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
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Batch サービスからのエラー。 サイズ変更中の状態ではないプールでこの API を呼び出すと、要求は HTTP 状態コード 409 で失敗します。

セキュリティ

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 stop resize

要求のサンプル

POST account.region.batch.azure.com/pools/poolId/stopresize?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

メッセージのテキスト。