Pool - Enable Auto Scale

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

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 demande. 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 {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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 sur lequel activer la mise à l’échelle automatique.
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.

Corps de la demande

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

Nom Type Description
autoScaleEvaluationInterval

string

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 15 minutes. Les valeurs minimale et maximale sont respectivement de 5 minutes et 168 heures. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la requête avec une erreur de valeur de propriété non valide ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, la planification d’évaluation de mise à l’échelle automatique existante est arrêtée et une nouvelle planification d’évaluation de mise à l’échelle automatique est démarrée, l’heure de début étant l’heure à laquelle cette demande a été émise.
autoScaleFormula

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool.
La formule est vérifiée pour la validité avant d’être appliquée au pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations détaillées sur l’erreur. Pour plus d’informations sur la spécification de cette formule, consultez Mise à l’échelle automatique des nœuds de calcul dans un pool Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Réponses

Nom Type Description
200 OK

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

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: 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 enable autoscale

Sample Request

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



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

Sample Response

Status code:
200

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

Options permettant d’activer la mise à l’échelle automatique sur un pool.

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.

PoolEnableAutoScaleParameter

Options permettant d’activer la mise à l’échelle automatique sur un pool.

Nom Type Description
autoScaleEvaluationInterval

string

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 15 minutes. Les valeurs minimale et maximale sont respectivement de 5 minutes et 168 heures. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la requête avec une erreur de valeur de propriété non valide ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, la planification d’évaluation de mise à l’échelle automatique existante est arrêtée et une nouvelle planification d’évaluation de mise à l’échelle automatique est démarrée, l’heure de début étant l’heure à laquelle cette demande a été émise.
autoScaleFormula

string

Formule pour le nombre souhaité de nœuds de calcul dans le pool.
La formule est vérifiée pour la validité avant d’être appliquée au pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations détaillées sur l’erreur. Pour plus d’informations sur la spécification de cette formule, consultez Mise à l’échelle automatique des nœuds de calcul dans un pool Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).