Partager via

Pools - Resize Pool

Service:
Batch Service
Version d'API:
2025-06-01

Modifie le nombre de nœuds de calcul affectés à un pool.
Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le redimensionnement du pool est déjà effectué, la demande échoue avec le code d’état 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe du redimensionnement stable au redimensionnement. Vous ne pouvez pas redimensionner les pools configurés pour la mise à l’échelle automatique. Si vous essayez de le faire, le service Batch retourne une erreur 409. Si vous redimensionnez un pool vers le bas, le service Batch choisit les nœuds de calcul à supprimer. Pour supprimer des nœuds de calcul spécifiques, utilisez plutôt l’API Nœuds de calcul.

POST {endpoint}/pools/{poolId}/resize?api-version=2025-06-01
Avec des paramètres facultatifs: 
POST {endpoint}/pools/{poolId}/resize?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

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

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.

Corps de la demande

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

Nom Type Description
nodeDeallocationOption

BatchNodeDeallocationOption

Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution si la taille du pool diminue. La valeur par défaut est requeue.
resizeTimeout

string (duration)

Délai d’expiration de l’allocation de nœuds au pool ou suppression de nœuds de calcul du pool. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
targetDedicatedNodes

integer (int32)

Nombre souhaité de nœuds de calcul dédiés dans le pool.
targetLowPriorityNodes

integer (int32)

Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool.

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

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • 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 resize

Exemple de requête

POST {endpoint}/pools/resizePool/resize?api-version=2025-06-01



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

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.
BatchNodeDeallocationOption

BatchNodeDeallocationOption enums
BatchPoolResizeOptions

Paramètres de modification de la taille d’un pool 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.

BatchNodeDeallocationOption

Énumération

BatchNodeDeallocationOption enums

Valeur Description
requeue

Arrêtez l’exécution des processus de tâche et réinitialisation de la file d’attente des tâches. Les tâches s’exécutent à nouveau lorsqu’un nœud de calcul est disponible. Supprimez les nœuds de calcul dès que les tâches ont été arrêtées.
terminate

Terminez l’exécution des tâches. Les tâches sont terminées avec failureInfo indiquant qu’elles ont été arrêtées et ne sont pas réexécuter. Supprimez les nœuds de calcul dès que les tâches ont été arrêtées.
taskcompletion

Autoriser l’exécution des tâches en cours d’exécution. Planifiez aucune nouvelle tâche en attendant. Supprimez les nœuds de calcul lorsque toutes les tâches sont terminées.
retaineddata

Obsolète, nous vous encourageons à charger les données de tâche dans le stockage Azure dans votre tâche et à les utiliser TaskCompletion à la place. Autorisez la fin des tâches en cours d’exécution, puis attendez que toutes les périodes de rétention des données de tâche expirent. Planifiez aucune nouvelle tâche en attendant. Supprimez les nœuds de calcul lorsque toutes les périodes de rétention des tâches ont expiré.

BatchPoolResizeOptions

Objet

Paramètres de modification de la taille d’un pool Azure Batch.

Nom Type Description
nodeDeallocationOption

BatchNodeDeallocationOption

Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution si la taille du pool diminue. La valeur par défaut est requeue.
resizeTimeout

string (duration)

Délai d’expiration de l’allocation de nœuds au pool ou suppression de nœuds de calcul du pool. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
targetDedicatedNodes

integer (int32)

Nombre souhaité de nœuds de calcul dédiés dans le pool.
targetLowPriorityNodes

integer (int32)

Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool.