Pool - Delete

Service:

Batch Service

API Version:

2023-11-01.18.0

從指定的帳戶中刪除集區。
當您要求刪除集區時，會發生下列動作：集區狀態設定為刪除;集區上任何進行中的重設大小作業會停止;Batch 服務會開始將集區大小調整為零計算節點;任何在現有計算節點上執行的工作都會終止，並重新排入佇列 (，就像已使用預設重新佇列選項要求重設大小集區作業一樣) ;最後，集區會從系統中移除。 由於已重新佇列執行工作，因此使用者可以藉由更新工作來以不同的集區為目標來重新執行這些工作。 工作接著可以在新的集區上執行。 如果您想要覆寫重新佇列行為，則應該先明確地呼叫調整集區的大小，將集區壓縮為零大小，再刪除集區。 如果您在集區上呼叫更新、修補或刪除 API 處於刪除狀態，它會失敗，HTTP 狀態代碼為 409，並出現錯誤碼 PoolBeingDeleted。

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

With optional parameters:

DELETE {batchUrl}/pools/{poolId}?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
Other Status Codes	BatchError	Batch 服務的錯誤。

安全性

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 delete

Sample Request

HTTP

DELETE account.region.batch.azure.com/pools/poolId?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	訊息的文字。