Pool - Resize

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Altera o número de nós de computação atribuídos a um pool.
Você só pode redimensionar um Pool quando seu estado de alocação estiver estável. Se o Pool já estiver redimensionando, a solicitação falhará com o código de status 409. Quando você redimensiona um Pool, o estado de alocação do pool muda de estável para redimensionamento. Não é possível redimensionar pools configurados para dimensionamento automático. Se você tentar fazer isso, o serviço do Lote retornará um erro 409. Se você redimensionar um Pool para baixo, o serviço lote escolherá quais nós de computação remover. Para remover nós de computação específicos, use a API Remover Nós de Computação do Pool.

POST {batchUrl}/pools/{poolId}/resize?api-version=2024-07-01.20.0

Com parâmetros opcionais:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
poolId	path	True	string	A ID do pool a ser redimensionada.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer (int32)	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. A predefinição é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string (uuid)	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-rfc1123)	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-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.
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 será executada somente se o recurso no serviço tiver sido modificado desde o horário especificado.
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 será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado.

Corpo da solicitação

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

Nome	Tipo	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução se o tamanho do Pool estiver diminuindo. O valor padrão é requeue.
resizeTimeout	string (duration)	O tempo limite para alocação de nós no pool ou remoção de nós de computação do pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).
targetDedicatedNodes	integer (int32)	O número desejado de nós de computação dedicados no pool.
targetLowPriorityNodes	integer (int32)	O número desejado de nós de computação spot/de baixa prioridade no pool.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação para o serviço do Lote foi bem-sucedida. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Segurança

azure_auth

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

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Pool resize

Solicitação de exemplo

HTTP

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2024-07-01.20.0



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Resposta de exemplo

Código de status:

202

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.
ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução após ele ter sido selecionado para desalocação.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
PoolResizeParameter	Opções para alterar o tamanho de um pool.

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	ErrorMessage	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.

ComputeNodeDeallocationOption

Enumeração

Determina o que fazer com um Nó de Computação e suas tarefas em execução após ele ter sido selecionado para desalocação.

Valor	Description
requeue	Encerre a execução de processos de tarefa e requeue as Tarefas. As Tarefas serão executadas novamente quando um Nó de Computação estiver disponível. Remova nós de computação assim que as tarefas tiverem sido encerradas.
retaineddata	Permita que tarefas em execução sejam concluídas no momento e aguarde até que todos os períodos de retenção de dados da tarefa expirem. Agendar nenhuma nova tarefa enquanto aguarda. Remova nós de computação quando todos os períodos de retenção da tarefa expirarem.
taskcompletion	Permitir que tarefas em execução sejam concluídas no momento. Agendar nenhuma nova tarefa enquanto aguarda. Remova nós de computação quando todas as tarefas tiverem sido concluídas.
terminate	Encerrar a execução de tarefas. As Tarefas serão concluídas com failureInfo indicando que foram encerradas e não serão executadas novamente. Remova nós de computação assim que as tarefas tiverem sido encerradas.

ErrorMessage

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.

PoolResizeParameter

Objeto

Opções para alterar o tamanho de um pool.

Nome	Tipo	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução se o tamanho do Pool estiver diminuindo. O valor padrão é requeue.
resizeTimeout	string (duration)	O tempo limite para alocação de nós no pool ou remoção de nós de computação do pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).
targetDedicatedNodes	integer (int32)	O número desejado de nós de computação dedicados no pool.
targetLowPriorityNodes	integer (int32)	O número desejado de nós de computação spot/de baixa prioridade no pool.