Pools - Delete Pool

Serviço:

Batch Service

Versão da API:

2025-06-01

Exclui um pool da conta especificada.
Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do pool está definido como exclusão; qualquer operação de redimensionamento em andamento no Pool é interrompida; o serviço do Lote começa a redimensionar o pool para zero Nós de Computação; as tarefas em execução em nós de computação existentes são encerradas e requeadas (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de requeue padrão); por fim, o Pool é removido do sistema. Como as tarefas em execução são requeuídas, o usuário pode executar novamente essas Tarefas atualizando seu trabalho para direcionar um pool diferente. Em seguida, as Tarefas podem ser executadas no novo Pool. Se você quiser substituir o comportamento de substituição, chame o pool de redimensionamento explicitamente para reduzir o pool para tamanho zero antes de excluir o Pool. Se você chamar uma API de Atualização, Patch ou Exclusão em um Pool no estado de exclusão, ela falhará com o código de status HTTP 409 com o código de erro PoolBeingDeleted.

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

Com parâmetros opcionais:

DELETE {endpoint}/pools/{poolId}?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	A ID do Pool a ser obtido.
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

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.
If-Modified-Since		string (date-time-rfc7231)	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-rfc7231)	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.
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.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos 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 delete

Solicitação de exemplo

HTTP

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

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.
BatchErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

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.