Partilhar via

Pools - Evaluate Pool Auto Scale

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

Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Pool.
Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.

POST {endpoint}/pools/{poolId}/evaluateautoscale?api-version=2025-06-01
Com parâmetros opcionais: 
POST {endpoint}/pools/{poolId}/evaluateautoscale?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

O ID do Pool sobre o qual avaliar a fórmula automática de escalabilidade.
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.

Corpo do Pedido

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

Name Necessário Tipo Description
autoScaleFormula True

string

A fórmula para o número desejado de nós de computação no pool. A fórmula é validada e os seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, 'Ativar escalonamento automático num Pool'. Para mais informações sobre a especificação desta fórmula, veja Escalar automaticamente os Nós de Computação num Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Respostas

Name Tipo Description
200 OK

AutoScaleRun

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

Pedido de amostra

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



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

Resposta da amostra

Código de estado:
200 
{
  "timestamp": "2025-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definições

Name Description
AutoScaleRun

Os resultados e erros de uma execução de uma fórmula de escala automática de Pool.
AutoScaleRunError

Um erro que ocorreu ao executar ou avaliar uma fórmula de escala automática de pool.
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.
BatchPoolEvaluateAutoScaleOptions

Parâmetros para avaliar uma fórmula de dimensionamento automático em um Pool de Lotes do Azure.
NameValuePair

Representa um par nome-valor.

AutoScaleRun

Object

Os resultados e erros de uma execução de uma fórmula de escala automática de Pool.

Name Tipo Description
error

AutoScaleRunError

Detalhes do erro encontrado ao avaliar a fórmula de autoescala no Pool, caso a avaliação não tenha sido bem-sucedida.
results

string

Os valores finais de todas as variáveis utilizadas na avaliação da fórmula de autoescala. Cada valor de variável é retornado na forma $variable=valor, e as variáveis são separadas por ponto-e-vírgula.
timestamp

string (date-time)

O momento em que a fórmula em escala automática foi avaliada pela última vez.

AutoScaleRunError

Object

Um erro que ocorreu ao executar ou avaliar uma fórmula de escala automática de pool.

Name Tipo Description
code

string

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

string

Uma mensagem que descreve o erro de autoscale, destinada a ser adequada para exibição numa interface de utilizador.
values

NameValuePair[]

Uma lista de detalhes adicionais de erro relacionados com o erro de autoescala.

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.

BatchPoolEvaluateAutoScaleOptions

Object

Parâmetros para avaliar uma fórmula de dimensionamento automático em um Pool de Lotes do Azure.

Name Tipo Description
autoScaleFormula

string

A fórmula para o número desejado de nós de computação no pool. A fórmula é validada e os seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, 'Ativar escalonamento automático num Pool'. Para mais informações sobre a especificação desta fórmula, veja Escalar automaticamente os Nós de Computação num Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Object

Representa um par nome-valor.

Name Tipo Description
name

string

O nome no par nome-valor.
value

string

O valor no par nome-valor.