Dela via

Pool - Delete

Tjänst:
Batch Service
API-version:
2024-07-01.20.0

Tar bort en pool från det angivna kontot.
När du begär att en pool ska tas bort utförs följande åtgärder: Pooltillståndet är inställt på att ta bort; alla pågående storleksändringsåtgärder i poolen stoppas. Batch-tjänsten börjar ändra storlek på poolen till noll beräkningsnoder. Alla aktiviteter som körs på befintliga beräkningsnoder avslutas och sparas på nytt (som om en storleksändringsåtgärd för pool hade begärts med standardalternativet för att spara). Slutligen tas poolen bort från systemet. Eftersom aktiviteter som körs hämtas på nytt kan användaren köra aktiviteterna igen genom att uppdatera sitt jobb för att rikta in sig på en annan pool. Aktiviteterna kan sedan köras på den nya poolen. Om du vill åsidosätta återköbeteendet bör du anropa ändra storlek på poolen explicit för att minska poolen till nollstorlek innan du tar bort poolen. Om du anropar ett API för uppdatering, korrigering eller borttagning i en pool i borttagningstillståndet misslyckas det med HTTP-statuskod 409 med felkoden PoolBeingDeleted.

DELETE {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0
Med valfria parametrar: 
DELETE {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2024-07-01.20.0

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
 path True

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.
poolId
 path True

string

ID:t för poolen som ska tas bort.
api-version
 query True

string

Klient-API-version.
timeout
 query

integer (int32)

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name Obligatorisk Typ Description
client-request-id

string (uuid)

Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Om servern ska returnera klient-request-id i svaret.
ocp-date

string (date-time-rfc1123)

Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.
If-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since

string (date-time-rfc1123)

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since

string (date-time-rfc1123)

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.

Svar

Name Typ Description
202 Accepted

Begäran till Batch-tjänsten lyckades.

Sidhuvuden

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Pool delete

Exempelbegäran

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

Exempelsvar

Statuskod:
202

Definitioner

Name Description
BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

BatchError

Objekt

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message

ErrorMessage

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values

BatchErrorDetail[]

En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Objekt

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name Typ Description
key

string

En identifierare som anger innebörden av egenskapen Value.
value

string

Den ytterligare information som ingår i felsvaret.

ErrorMessage

Objekt

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name Typ Description
lang

string

Språkkoden för felmeddelandet
value

string

Texten i meddelandet.