Partager via

Pools - Evaluate Pool Auto Scale

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

Obtient le résultat de l’évaluation d’une formule de mise à l’échelle automatique sur le pool.
Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule.

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

L’ID du Pool sur lequel évaluer la formule d’échelle automatique.
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.

Corps de la demande

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

Nom Obligatoire Type Description
autoScaleFormula True

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool. La formule est validée et ses résultats calculés, mais elle n’est pas appliquée au Pool. Pour appliquer la formule au Pool, « Activez l’échelle automatique sur un Pool ». Pour plus d’informations sur la spécification de cette formule, voir Scale automatique des nœuds de calcul dans un pool batch Azure (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Réponses

Nom Type Description
200 OK

AutoScaleRun

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

Exemple de requête

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Exemple de réponse

Code d’état:
200 
{
  "timestamp": "2025-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Définitions

Nom Description
AutoScaleRun

Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool.
AutoScaleRunError

Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool.
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.
BatchPoolEvaluateAutoScaleOptions

Paramètres d’évaluation d’une formule de mise à l’échelle automatique sur un pool Azure Batch.
NameValuePair

Représente une paire nom-valeur.

AutoScaleRun

Objet

Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool.

Nom Type Description
error

AutoScaleRunError

Détails de l’erreur rencontrée évaluant la formule d’autoscale sur le Pool, si l’évaluation échouait.
results

string

Valeurs finales de toutes les variables utilisées dans l’évaluation de la formule de mise à l’échelle automatique. Chaque valeur de variable est retournée sous la forme $variable=value, et les variables sont séparées par des points-virgules.
timestamp

string (date-time)

Heure à laquelle la formule de mise à l’échelle automatique a été évaluée pour la dernière fois.

AutoScaleRunError

Objet

Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool.

Nom Type Description
code

string

Un identifiant pour l’erreur d’autoscale. Les codes sont invariants et sont destinés à être consommés par programme.
message

string

Un message décrivant l’erreur d’autoscale, destiné à être affiché dans une interface utilisateur.
values

NameValuePair[]

Une liste de détails supplémentaires sur l’erreur liée à l’erreur d’autoscale.

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.

BatchPoolEvaluateAutoScaleOptions

Objet

Paramètres d’évaluation d’une formule de mise à l’échelle automatique sur un pool Azure Batch.

Nom Type Description
autoScaleFormula

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool. La formule est validée et ses résultats calculés, mais elle n’est pas appliquée au Pool. Pour appliquer la formule au Pool, « Activez l’échelle automatique sur un Pool ». Pour plus d’informations sur la spécification de cette formule, voir Scale automatique des nœuds de calcul dans un pool batch Azure (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Objet

Représente une paire nom-valeur.

Nom Type Description
name

string

Le nom dans la paire nom-valeur.
value

string

La valeur dans la paire nom-valeur.