Pool - Delete

Service:

Batch Service

API Version:

2023-11-01.18.0

Elimina un pool dall'account specificato.
Quando si richiede l'eliminazione di un pool, si verificano le azioni seguenti: lo stato del pool è impostato per l'eliminazione; tutte le operazioni di ridimensionamento in corso nel pool vengono arrestate; il servizio Batch avvia il ridimensionamento del pool a zero nodi di calcolo; tutte le attività in esecuzione nei nodi di calcolo esistenti vengono terminate e accodate (come se fosse stata richiesta un'operazione di ridimensionamento del pool con l'opzione di accodamento predefinita); infine, il pool viene rimosso dal sistema. Poiché le attività in esecuzione vengono riqueuate, l'utente può rieseguire queste attività aggiornando il processo in modo che venga usata come destinazione un pool diverso. Le attività possono quindi essere eseguite nel nuovo pool. Se si vuole eseguire l'override del comportamento di accodamento, è necessario chiamare ridimensionare il pool in modo esplicito per ridurre le dimensioni del pool a zero prima di eliminare il pool. Se si chiama un'API Update, Patch o Delete in un pool nello stato di eliminazione, l'operazione avrà esito negativo con codice di stato HTTP 409 con il codice di errore 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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste di servizio Azure Batch.
poolId	path	True	string	ID del pool da eliminare.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer int32	Tempo massimo per cui il server può dedicare l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string uuid	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string date-time-rfc1123	Ora di emissione della richiesta. Le librerie client impostano in genere questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.
If-Match		string	Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio corrisponde esattamente al valore specificato dal client.
If-None-Match		string	Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio non corrisponde al valore specificato dal client.
If-Modified-Since		string date-time-rfc1123	Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio è stata modificata dall'ora specificata.
If-Unmodified-Since		string date-time-rfc1123	Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dall'ora specificata.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta al servizio Batch ha avuto esito positivo. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Errore del servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso del codice di autenticazione OAuth 2.0

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

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

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.