Pool - Delete

服務:

Batch Service

API 版本:

2024-07-01.20.0

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

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

含選擇性參數:

DELETE {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2024-07-01.20.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秒。 如果值大於 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 服務的要求成功。 標題 client-request-id: string request-id: string
Other Status Codes	BatchError	Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Pool delete

範例要求

HTTP

DELETE account.region.batch.azure.com/pools/poolId?api-version=2024-07-01.20.0

範例回覆

狀態碼:

202

定義

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

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ErrorMessage

Object

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

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