Pool - Enable Auto Scale

Ativa o dimensionamento automático para um Conjunto.
Não pode ativar o dimensionamento automático num Conjunto se estiver em curso uma operação de redimensionamento no Conjunto. Se o dimensionamento automático do Conjunto estiver atualmente desativado, tem de especificar uma fórmula de dimensionamento automático válida como parte do pedido. Se o dimensionamento automático do Conjunto já estiver ativado, poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não pode chamar esta API para o mesmo Conjunto mais do que uma vez a cada 30 segundos.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
path True

string

O URL base para todos os pedidos de serviço Azure Batch.

poolId
path True

string

O ID do Conjunto no qual pode ativar o dimensionamento automático.

api-version
query True

string

Versão da API de Cliente.

timeout
query

integer

int32

O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

uuid

A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Se o servidor deve devolver o client-request-id na resposta.

ocp-date

string

date-time-rfc1123

A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

If-Match

string

Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada 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 conhecido pelo cliente. A operação só será efetuada se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

If-Modified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço tiver sido modificado desde a hora especificada.

If-Unmodified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço não tiver sido modificado desde a hora especificada.

Corpo do Pedido

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

Name Tipo Description
autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do Conjunto de acordo com a fórmula de dimensionamento automático.
O valor predefinido é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respetivamente. Se especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch rejeita o pedido com um erro de valor de propriedade inválido; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto). Se especificar um novo intervalo, a agenda de avaliação de dimensionamento automático existente será interrompida e será iniciada uma nova agenda de avaliação de dimensionamento automático, sendo a hora de início a hora em que este pedido foi emitido.

autoScaleFormula

string

A fórmula para o número pretendido de Nós de Computação no Conjunto.
A fórmula é verificada quanto à validade antes de ser aplicada ao Conjunto. Se a fórmula não for válida, o serviço Batch rejeita o pedido com informações de erro detalhadas. Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Respostas

Name Tipo Description
200 OK

O pedido para o serviço Batch foi efetuado com êxito.

Headers

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

BatchError

O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Pool enable autoscale

Sample Request

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2023-11-01.18.0



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

Sample Response

Definições

Name Description
BatchError

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

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

PoolEnableAutoScaleParameter

Opções para ativar o dimensionamento automático num Conjunto.

BatchError

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

Name Tipo Description
code

string

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

message

ErrorMessage

Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.

values

BatchErrorDetail[]

Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Valor.

value

string

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

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name Tipo Description
lang

string

O código de idioma da mensagem de erro

value

string

O texto da mensagem.

PoolEnableAutoScaleParameter

Opções para ativar o dimensionamento automático num Conjunto.

Name Tipo Description
autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do Conjunto de acordo com a fórmula de dimensionamento automático.
O valor predefinido é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respetivamente. Se especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch rejeita o pedido com um erro de valor de propriedade inválido; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto). Se especificar um novo intervalo, a agenda de avaliação de dimensionamento automático existente será interrompida e será iniciada uma nova agenda de avaliação de dimensionamento automático, sendo a hora de início a hora em que este pedido foi emitido.

autoScaleFormula

string

A fórmula para o número pretendido de Nós de Computação no Conjunto.
A fórmula é verificada quanto à validade antes de ser aplicada ao Conjunto. Se a fórmula não for válida, o serviço Batch rejeita o pedido com informações de erro detalhadas. Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).