Partilhar via

Pools - Enable Pool Auto Scale

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

Permite o dimensionamento automático para um pool.
Não é possível 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. Não é possível 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 do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

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

string

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

string

minLength: 1

A versão da API a utilizar 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 superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

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

boolean

Se o servidor deve retornar o client-request-id na resposta.
ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para 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 tempo 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 tempo especificado.
If-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se o 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 do Pedido

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

Name 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 são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch 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 especificar um novo intervalo, então o cronograma de avaliação autoscale existente será interrompido e um novo calendário de avaliação autoscale será iniciado, sendo o seu horário de início o momento em que este pedido foi emitido.
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 são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch 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 especificar um novo intervalo, então o cronograma de avaliação autoscale existente será interrompido e um novo calendário de avaliação autoscale será iniciado, sendo o seu horário de início o momento em que este pedido foi emitido.

Respostas

Name Tipo Description
200 OK

O pedido foi bem-sucedido.

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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

Pool enable autoscale

Pedido de amostra

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



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

Resposta da amostra

Código de estado:
200

Definições

Name Description
BatchError

Uma resposta de erro recebida do serviço Batch 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

Object

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

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

BatchErrorMessage

Uma mensagem descrevendo 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

Object

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

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

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

BatchErrorMessage

Object

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

Name Tipo Description
lang

string

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

string

O texto da mensagem.

BatchPoolEnableAutoScaleOptions

Object

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

Name 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 são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch 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 especificar um novo intervalo, então o cronograma de avaliação autoscale existente será interrompido e um novo calendário de avaliação autoscale será iniciado, sendo o seu horário de início o momento em que este pedido foi emitido.
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 são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch 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 especificar um novo intervalo, então o cronograma de avaliação autoscale existente será interrompido e um novo calendário de avaliação autoscale será iniciado, sendo o seu horário de início o momento em que este pedido foi emitido.