Compartilhar via

Pools - Enable Pool Auto Scale

Serviço:
Batch Service
Versão da API:
2025-06-01

Habilita o dimensionamento automático para um pool.
Você não poderá habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Você não pode chamar essa API para o mesmo pool mais de uma vez a cada 30 segundos.

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01
Com parâmetros opcionais: 
POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01&timeOut={timeOut}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

A ID do Pool a ser obtido.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
timeOut
 query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado em seu lugar.".

Cabeçalho da solicitação

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

Nome Obrigatório Tipo Description
client-request-id

string

A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date

string (date-time-rfc7231)

A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.
If-Modified-Since

string (date-time-rfc7231)

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde o horário especificado.
If-Unmodified-Since

string (date-time-rfc7231)

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado.
If-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.
If-None-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

Corpo da solicitação

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

Nome Tipo Description
autoScaleEvaluationInterval

string (duration)

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). Se você especificar um novo intervalo, então o cronograma de avaliação de autoescala existente será interrompido e um novo cronograma de avaliação de autoescala será iniciado, com seu horário de início sendo o momento em que essa solicitação foi emitida.
autoScaleFormula

string

A fórmula para o número desejado de Nós de Computação no Pool. O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). Se você especificar um novo intervalo, então o cronograma de avaliação de autoescala existente será interrompido e um novo cronograma de avaliação de autoescala será iniciado, com seu horário de início sendo o momento em que essa solicitação foi emitida.

Respostas

Nome Tipo Description
200 OK

A solicitação foi bem-sucedida.

Cabeçalhos

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

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

Pool enable autoscale

Solicitação de exemplo

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



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

Resposta de exemplo

Código de status:
200

Definições

Nome Description
BatchError

Uma resposta de erro recebida do serviço do Lote do Azure.
BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchPoolEnableAutoScaleOptions

Parâmetros para habilitar o dimensionamento automático em um Pool de Lotes do Azure.

BatchError

Objeto

Uma resposta de erro recebida do serviço do Lote do Azure.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message

BatchErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Objeto

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Nome Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

As informações adicionais incluídas na resposta de erro.

BatchErrorMessage

Objeto

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro.
value

string

O texto da mensagem.

BatchPoolEnableAutoScaleOptions

Objeto

Parâmetros para habilitar o dimensionamento automático em um Pool de Lotes do Azure.

Nome Tipo Description
autoScaleEvaluationInterval

string (duration)

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). Se você especificar um novo intervalo, então o cronograma de avaliação de autoescala existente será interrompido e um novo cronograma de avaliação de autoescala será iniciado, com seu horário de início sendo o momento em que essa solicitação foi emitida.
autoScaleFormula

string

A fórmula para o número desejado de Nós de Computação no Pool. O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). Se você especificar um novo intervalo, então o cronograma de avaliação de autoescala existente será interrompido e um novo cronograma de avaliação de autoescala será iniciado, com seu horário de início sendo o momento em que essa solicitação foi emitida.