Partager via

Pools - Enable Pool Auto Scale

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

Active la mise à l’échelle automatique pour un pool.
Vous ne pouvez pas activer la mise à l’échelle automatique sur un pool si une opération de redimensionnement est en cours sur le pool. Si la mise à l’échelle automatique du pool est actuellement désactivée, vous devez spécifier une formule de mise à l’échelle automatique valide dans le cadre de la requête. Si la mise à l’échelle automatique du pool est déjà activée, vous pouvez spécifier une nouvelle formule de mise à l’échelle automatique et/ou un nouvel intervalle d’évaluation. Vous ne pouvez pas appeler cette API pour le même pool plusieurs fois toutes les 30 secondes.

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

string (duration)

Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la demande avec une erreur de valeur de propriété non valide ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, alors le calendrier d’évaluation autoscale existant sera arrêté et un nouveau calendrier d’évaluation autoscale sera lancé, son heure de début étant le moment où cette requête a été émise.
autoScaleFormula

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la demande avec une erreur de valeur de propriété non valide ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, alors le calendrier d’évaluation autoscale existant sera arrêté et un nouveau calendrier d’évaluation autoscale sera lancé, son heure de début étant le moment où cette requête a été émise.

Réponses

Nom Type Description
200 OK

La demande a réussi.

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 enable autoscale

Exemple de requête

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Exemple de réponse

Code d’état:
200

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

Paramètres permettant d’activer la mise à l’échelle automatique sur 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.

BatchPoolEnableAutoScaleOptions

Objet

Paramètres permettant d’activer la mise à l’échelle automatique sur un pool Azure Batch.

Nom Type Description
autoScaleEvaluationInterval

string (duration)

Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la demande avec une erreur de valeur de propriété non valide ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, alors le calendrier d’évaluation autoscale existant sera arrêté et un nouveau calendrier d’évaluation autoscale sera lancé, son heure de début étant le moment où cette requête a été émise.
autoScaleFormula

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la demande avec une erreur de valeur de propriété non valide ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, alors le calendrier d’évaluation autoscale existant sera arrêté et un nouveau calendrier d’évaluation autoscale sera lancé, son heure de début étant le moment où cette requête a été émise.