Pool - Stop Resize

Service:

Batch Service

API Version:

2023-11-01.18.0

停止集區上的持續重設大小作業。
這不會在重設大小作業之前將集區還原到先前的狀態：它只會停止進行任何進一步的變更，而且集區會維持其目前狀態。 停止之後，集區會穩定在停止作業完成時所在的計算節點數目。 在停止作業期間，集區配置狀態會先變更為停止，然後再變更為穩定。 重設大小作業不需要明確重設大小集區要求;此 API 也可以用來在建立集區時停止初始重設大小。

POST {batchUrl}/pools/{poolId}/stopresize?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/stopresize?timeout={timeout}&api-version=2023-11-01.18.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
poolId	path	True	string	要停止重設大小之集區的標識碼。
api-version	query	True	string	用戶端 API 版本。
timeout	query		integer int32	伺服器可以花費在數秒內處理要求的時間上限。 預設值為 30 秒。

要求標頭

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

名稱	必要	類型	Description
client-request-id		string uuid	呼叫端產生的要求身分識別，格式為不含大括弧的 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	時間戳，指出用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時，才會執行作業。

回應

名稱	類型	Description
202 Accepted		Batch 服務的要求成功。 Headers 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 驗證碼流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬用戶帳戶

Authorization

Type: apiKey
In: header

範例

Pool stop resize

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/stopresize?api-version=2023-11-01.18.0

Sample Response

Status code:

202

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
ErrorMessage	在 Azure Batch 錯誤回應中收到的錯誤訊息。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應中包含的其他資訊。

ErrorMessage

在 Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。