Pool - Delete

Service:

Batch Service

API Version:

2023-11-01.18.0

Elimina un grupo de la cuenta especificada.
Cuando se solicita que se elimine un grupo, se producen las siguientes acciones: el estado del grupo se establece en eliminar; se detiene cualquier operación de cambio de tamaño en curso en el grupo; el servicio Batch comienza a cambiar el tamaño del grupo a cero nodos de proceso; Todas las tareas que se ejecutan en nodos de ejecución existentes se finalizan y se vuelven a poner en cola (como si se hubiera solicitado una operación de grupo de cambio de tamaño con la opción de requeue predeterminada); por último, el grupo se quita del sistema. Dado que las tareas en ejecución se vuelven a poner en cola, el usuario puede volver a ejecutar estas tareas actualizando su trabajo para tener como destino un grupo diferente. A continuación, las tareas se pueden ejecutar en el nuevo grupo. Si desea invalidar el comportamiento de la puesta en cola, debe llamar al grupo de cambio de tamaño explícitamente para reducir el grupo a un tamaño cero antes de eliminar el grupo. Si llama a una API Update, Patch o Delete en un grupo en el estado de eliminación, se producirá un error con el código de estado HTTP 409 con el código de error PoolBeingDeleted.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
poolId	path	True	string	Identificador del grupo que se va a eliminar.
api-version	query	True	string	Versión de la API de cliente.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
client-request-id		string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date		string date-time-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.
If-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
If-None-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación se realizará solo si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.
If-Modified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.
If-Unmodified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación se realizará solo si el recurso del servicio no se ha modificado desde el momento especificado.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud al servicio Batch se realizó correctamente. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

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

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Pool delete

Sample Request

HTTP

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

Sample Response

Status code:

202

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.