Pool - Delete

Service:

Batch Service

API Version:

2023-11-01.18.0

Odstraní fond ze zadaného účtu.
Když požádáte o odstranění fondu, dojde k následujícím akcím: Stav fondu je nastaven na odstranění; všechny probíhající operace změny velikosti ve fondu jsou zastaveny; Služba Batch zahájí změnu velikosti fondu na nulu výpočetních uzlů; Všechny úlohy spuštěné na existujících výpočetních uzlech se ukončí a znovu zadají do fronty (jako kdyby byla požadována operace změny velikosti fondu s výchozí možností opětovného zařazení do fronty); a nakonec se fond odebere ze systému. Vzhledem k tomu, že spuštěné úlohy se znovu zařazuje do fronty, může uživatel tyto úlohy znovu spustit aktualizací své úlohy tak, aby cílila na jiný fond. Úkoly se pak můžou spustit v novém fondu. Pokud chcete chování při opětovném vytvoření fronty přepsat, měli byste před odstraněním fondu explicitně zavolat změnit velikost fondu a zmenšit tak fond na nulu. Pokud zavoláte rozhraní API pro aktualizaci, opravu nebo odstranění ve fondu ve stavu odstraňování, dojde ke selhání se stavovým kódem HTTP 409 s kódem chyby 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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
poolId	path	True	string	ID fondu, který se má odstranit.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.
If-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě přesně odpovídá hodnotě zadané klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě neodpovídá hodnotě zadané klientem.
If-Modified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že se prostředek ve službě od zadaného času změnil.
If-Unmodified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že prostředek ve službě nebyl od zadaného času změněn.

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek na službu Batch byl úspěšný. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy