Compartir a través de

Pools - Enable Pool Auto Scale

Servicio:
Batch Service
Versión de la API:
2025-06-01

Habilita el escalado automático de un grupo.
No se puede habilitar el escalado automático en un grupo si hay una operación de cambio de tamaño en curso en el grupo. Si el escalado automático del grupo está deshabilitado actualmente, debe especificar una fórmula de escalado automático válida como parte de la solicitud. Si el escalado automático del grupo ya está habilitado, puede especificar una nueva fórmula de escalado automático o un nuevo intervalo de evaluación. No puede llamar a esta API para el mismo grupo más de una vez cada 30 segundos.

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01
Con parámetros opcionales: 
POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01&timeOut={timeOut}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

Punto de conexión de la cuenta de Batch (por ejemplo: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

Identificador del grupo que se va a obtener.
api-version
 query True

string

minLength: 1

La versión de API que se va a utilizar para esta operación.
timeOut
 query

integer (int32)

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
client-request-id

string

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date

string (date-time-rfc7231)

Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.
If-Modified-Since

string (date-time-rfc7231)

Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.
If-Unmodified-Since

string (date-time-rfc7231)

Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.
If-Match

string

Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
If-None-Match

string

Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.

Cuerpo de la solicitud

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

Nombre Tipo Description
autoScaleEvaluationInterval

string (duration)

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especificas un nuevo intervalo, entonces el calendario de evaluación de autoescalado existente se detendrá y se iniciará un nuevo calendario de evaluación de autoescala, siendo su hora de inicio la hora en que se emitió esta solicitud.
autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especificas un nuevo intervalo, entonces el calendario de evaluación de autoescalado existente se detendrá y se iniciará un nuevo calendario de evaluación de autoescala, siendo su hora de inicio la hora en que se emitió esta solicitud.

Respuestas

Nombre Tipo Description
200 OK

La solicitud se ha realizado correctamente.

Encabezados

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre Description
https://batch.core.windows.net//.default

Ejemplos

Pool enable autoscale

Solicitud de ejemplo

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



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

Respuesta de muestra

status code:
200

Definiciones

Nombre Description
BatchError

Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
BatchErrorMessage

Mensaje de error recibido en una respuesta de error de Azure Batch.
BatchPoolEnableAutoScaleOptions

Parámetros para habilitar el escalado automático en un grupo de Azure Batch.

BatchError

Objeto

Respuesta de error recibida del servicio Azure Batch.

Nombre Tipo Description
code

string

Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message

BatchErrorMessage

Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values

BatchErrorDetail[]

Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Objeto

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

Nombre Tipo Description
key

string

Identificador que especifica el significado de la propiedad Value.
value

string

La información adicional incluida con la respuesta de error.

BatchErrorMessage

Objeto

Mensaje de error recibido en una respuesta de error de Azure Batch.

Nombre Tipo Description
lang

string

El código de idioma del mensaje de error.
value

string

El texto del mensaje.

BatchPoolEnableAutoScaleOptions

Objeto

Parámetros para habilitar el escalado automático en un grupo de Azure Batch.

Nombre Tipo Description
autoScaleEvaluationInterval

string (duration)

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especificas un nuevo intervalo, entonces el calendario de evaluación de autoescalado existente se detendrá y se iniciará un nuevo calendario de evaluación de autoescala, siendo su hora de inicio la hora en que se emitió esta solicitud.
autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especificas un nuevo intervalo, entonces el calendario de evaluación de autoescalado existente se detendrá y se iniciará un nuevo calendario de evaluación de autoescala, siendo su hora de inicio la hora en que se emitió esta solicitud.