Pools - Delete Pool

Service:

Batch Service

Version d'API:

2025-06-01

Supprime un pool du compte spécifié.
Lorsque vous demandez qu’un pool soit supprimé, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted.

DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01

Avec des paramètres facultatifs:

DELETE {endpoint}/pools/{poolId}?api-version=2025-06-01&timeOut={timeOut}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de compte Batch (par exemple : https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	ID du pool à obtenir.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
timeOut	query		integer (int32)	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. »

En-tête de la demande

Nom	Obligatoire	Type	Description
client-request-id		string	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date		string (date-time-rfc7231)	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.
If-Modified-Since		string (date-time-rfc7231)	Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.
If-Unmodified-Since		string (date-time-rfc7231)	Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.
If-Match		string	Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.
If-None-Match		string	Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

Réponses

Nom	Type	Description
202 Accepted		La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes client-request-id: string request-id: string
Other Status Codes	BatchError	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://batch.core.windows.net//.default

Exemples

Pool delete

Exemple de requête

HTTP

DELETE {endpoint}/pools/poolId?api-version=2025-06-01

Exemple de réponse

Code d’état:

202

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
BatchErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.

BatchError

Objet

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	BatchErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Objet

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

BatchErrorMessage

Objet

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Le code de langue du message d’erreur.
value	string	Le texte du message.