Compartilhar 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.
Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna 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 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

O ID do Pool para avaliar a fórmula automática de escalonamento.
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.

Corpo da solicitação

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

Nome Obrigató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 seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, 'Ative a escalonabilidade automática em um Pool'. Para mais informações sobre como especificar essa fórmula, veja Escalar automaticamente Nós de Computação em um Azure Batch Pool (https://v4.hkg1.meaqua.org/azure/batch/batch-automatic-scaling).

Respostas

Nome Tipo Description
200 OK

AutoScaleRun

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

Solicitação de exemplo

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



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

Resposta de exemplo

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

Definições

Nome Description
AutoScaleRun

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.
AutoScaleRunError

Erro ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.
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.
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

Objeto

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.

Nome Tipo Description
error

AutoScaleRunError

Detalhes do erro encontrado avaliando 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 usadas na avaliação da fórmula de dimensionamento automático. Cada valor de variável é retornado no formulário $variable=value e as variáveis são separadas por ponto-e-vírgula.
timestamp

string (date-time)

A hora em que a fórmula de dimensionamento automático foi avaliada pela última vez.

AutoScaleRunError

Objeto

Erro ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.

Nome Tipo Description
code

string

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

string

Uma mensagem descrevendo o erro de autoescalonamento, destinada a ser adequada para exibição em uma interface de usuário.
values

NameValuePair[]

Uma lista de detalhes adicionais de erro relacionados ao erro de autoescala.

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.

BatchPoolEvaluateAutoScaleOptions

Objeto

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

Nome 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 seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, 'Ative a escalonabilidade automática em um Pool'. Para mais informações sobre como especificar essa fórmula, veja Escalar automaticamente Nós de Computação em um Azure Batch Pool (https://v4.hkg1.meaqua.org/azure/batch/batch-automatic-scaling).

NameValuePair

Objeto

Representa um par nome-valor.

Nome Tipo Description
name

string

O nome no par nome-valor.
value

string

O valor no par nome-valor.