Pool - Resize

Service:

Batch Service

API Version:

2023-11-01.18.0

Altera o número de Nós de Computação atribuídos a um Conjunto.
Só pode redimensionar um Conjunto quando o respetivo estado de alocação estiver estável. Se o Conjunto já estiver a ser redimensionado, o pedido falhará com o código de estado 409. Quando redimensiona um Conjunto, o estado de alocação do Conjunto muda de estável para redimensionamento. Não é possível redimensionar conjuntos configurados para dimensionamento automático. Se tentar fazê-lo, o serviço Batch devolve um erro 409. Se redimensionar um Conjunto para baixo, o serviço Batch escolhe os Nós de Computação a remover. Para remover nós de computação específicos, utilize a API Remover Nós de Computação.

POST {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?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 a redimensionar.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode passar 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, na 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-o 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 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 conhecido pelo cliente. A operação só será efetuada se o 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 última hora modificada 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 última hora modificada 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
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e as respetivas tarefas em execução se o tamanho do Conjunto estiver a diminuir. O valor predefinido é voltar a colocar em fila.
resizeTimeout	string	O tempo limite para a alocação de Nós para o Conjunto ou remoção de Nós de Computação do Conjunto. O valor predefinido é 15 minutos. O valor mínimo é 5 minutos. Se especificar um valor inferior a 5 minutos, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
targetDedicatedNodes	integer	O número pretendido de Nós de Computação dedicados no Conjunto.
targetLowPriorityNodes	integer	O número pretendido de Nós de Computação Spot/Low-priority no Conjunto.

Respostas

Name	Tipo	Description
202 Accepted		O pedido ao 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 resize

Sample Request

HTTP

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



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

Sample Response

Status code:

202

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.
ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e as respetivas tarefas em execução depois de ter sido selecionado para desalocação.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
PoolResizeParameter	Opções para alterar o tamanho de um 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, destinada 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 de erro.

ComputeNodeDeallocationOption

Determina o que fazer com um Nó de Computação e as respetivas tarefas em execução depois de ter sido selecionado para desalocação.

Name	Tipo	Description
requeue	string	Termine os processos de tarefas em execução e volte a colocar em fila as Tarefas. As Tarefas serão executadas novamente quando um Nó de Computação estiver disponível. Remova Os Nós de Computação assim que as Tarefas tiverem sido terminadas.
retaineddata	string	Permita a conclusão das Tarefas atualmente em execução e, em seguida, aguarde que todos os períodos de retenção de dados da tarefa expirem. Não agende tarefas novas enquanto aguarda. Remova Os Nós de Computação quando todos os períodos de retenção de tarefas expirarem.
taskcompletion	string	Permitir a conclusão das Tarefas atualmente em execução. Não agende tarefas novas enquanto aguarda. Remova Os Nós de Computação quando todas as Tarefas estiverem concluídas.
terminate	string	Termine a execução de Tarefas. As Tarefas serão concluídas com failureInfo a indicar que foram terminadas e que não serão executadas novamente. Remova Os Nós de Computação assim que as Tarefas tiverem sido terminadas.

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.

PoolResizeParameter

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

Name	Tipo	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e as respetivas tarefas em execução se o tamanho do Conjunto estiver a diminuir. O valor predefinido é voltar a colocar em fila.
resizeTimeout	string	O tempo limite para a alocação de Nós para o Conjunto ou remoção de Nós de Computação do Conjunto. O valor predefinido é 15 minutos. O valor mínimo é 5 minutos. Se especificar um valor inferior a 5 minutos, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
targetDedicatedNodes	integer	O número pretendido de Nós de Computação dedicados no Conjunto.
targetLowPriorityNodes	integer	O número pretendido de Nós de Computação Spot/Low-priority no Conjunto.