Pool - Remove Nodes

Service:

Batch Service

API Version:

2023-11-01.18.0

Remove nós de computação do pool especificado.
Essa operação só pode ser executada quando o estado de alocação do Pool é estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.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 Lote do Azure.
poolId	path	True	string	A ID do pool do qual você deseja remover nós de computação.
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. O padrão é 30 segundos.

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 o client-request-id 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 conhecido 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 conhecido 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 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 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	Obrigatório	Tipo	Description
nodeList	True	string[]	Uma lista que contém as IDs dos Nós de Computação a serem removidos do pool especificado. Um máximo de 100 nós pode ser removido por solicitação.
nodeDeallocationOption		ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução depois de ter sido selecionado para desalocação. O valor padrão é colocar novamente na fila.
resizeTimeout		string	O tempo limite para a remoção de nós de computação para o pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação para o serviço do Lote foi bem-sucedida. Headers 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

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

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Pool remove nodes

Sample Request

HTTP

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



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Sample Response

Status code:

202

Definições

Nome	Description
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução depois de ter sido selecionado para desalocação.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
NodeRemoveParameter	Opções para remover nós de computação de um pool.

BatchError

Uma resposta de erro recebida do serviço 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

Um item de informações adicionais incluído em uma resposta de erro 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

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

Nome	Tipo	Description
requeue	string	Encerre a execução dos processos da tarefa e requeira 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 forem encerradas.
retaineddata	string	Permita que tarefas em execução no momento sejam concluídas e aguarde até que todos os períodos de retenção de dados da tarefa expirem. Não agende nenhuma nova Tarefa enquanto aguarda. Remova nós de computação quando todos os períodos de retenção de tarefa expirarem.
taskcompletion	string	Permitir que tarefas em execução no momento sejam concluídas. Não agende nenhuma nova Tarefa enquanto aguarda. Remova nós de computação quando todas as Tarefas tiverem sido concluídas.
terminate	string	Encerre 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 forem encerradas.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

NodeRemoveParameter

Opções para remover nós de computação de um pool.

Nome	Tipo	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina o que fazer com um Nó de Computação e suas tarefas em execução depois de ter sido selecionado para desalocação. O valor padrão é colocar novamente na fila.
nodeList	string[]	Uma lista que contém as IDs dos Nós de Computação a serem removidos do pool especificado. Um máximo de 100 nós pode ser removido por solicitação.
resizeTimeout	string	O tempo limite para a remoção de nós de computação para o pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).