Pool - Delete

  • Référence
Service:
Batch Service
API Version:
2023-11-01.18.0

Supprime un pool du compte spécifié.
Lorsque vous demandez la suppression d’un pool, 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 commence à redimensionner le pool à zéro nœuds de calcul ; toutes les tâches s’exécutant sur des nœuds de calcul existants sont arrêtées et mises en file d’attente (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 remises en file d’attente, l’utilisateur peut réexécuter ces tâches en mettant à jour son 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 la file d’attente, vous devez appeler redimensionner le pool explicitement pour réduire le pool à une taille nulle avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool à l’état de suppression, elle échoue avec le code HTTP status 409 avec le code d’erreur 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

Paramètres URI

Nom Dans Obligatoire Type Description
batchUrl
 path True

string

URL de base pour toutes les demandes de service Azure Batch.
poolId
 path True

string

ID du pool à supprimer.
api-version
 query True

string

Version de l’API cliente.
timeout
 query

integer

int32

Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom Obligatoire Type Description
client-request-id

string

uuid

Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date

string

date-time-rfc1123

Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.
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.
If-Modified-Since

string

date-time-rfc1123

Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée.
If-Unmodified-Since

string

date-time-rfc1123

Horodatage indiquant l’heure de la 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.

Réponses

Nom Type Description
202 Accepted

La demande adressée au service Batch a réussi.

Headers

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

BatchError

Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Pool delete

Sample Request

DELETE account.region.batch.azure.com/pools/poolId?api-version=2023-11-01.18.0

Sample Response

Status code:
202

Définitions

Nom Description
BatchError

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

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

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

BatchError

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 programmation.
message

ErrorMessage

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

Élément d’informations supplémentaires incluses 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.

ErrorMessage

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

Nom Type Description
lang

string

Code de langue du message d’erreur
value

string

Texte du message.