Pool - Delete

Service:

Batch Service

API Version:

2023-11-01.18.0

Удаляет пул из указанной учетной записи.
При запросе на удаление пула выполняются следующие действия: состояние пула — удаление; любая текущая операция изменения размера в пуле останавливается; Пакетная служба начинает изменять размер пула до нуля вычислительных узлов; все задачи, выполняемые на существующих вычислительных узлах, завершаются и отправляются в очередь (как если бы была запрошена операция изменения размера пула с параметром повторной очереди по умолчанию); наконец, пул удаляется из системы. Так как выполняемые задачи выполняются повторно, пользователь может повторно выполнить эти задачи, обновив задание для другого пула. Затем задачи могут выполняться в новом пуле. Если вы хотите переопределить поведение повторной отправки, необходимо явно вызвать изменение размера пула, чтобы уменьшить размер пула до нуля перед удалением пула. При вызове API обновления, исправления или удаления в пуле в состоянии удаления произойдет сбой с кодом состояния HTTP 409 с кодом ошибки 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

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
poolId	path	True	string	Идентификатор удаляемого пула.
api-version	query	True	string	Версия API клиента.
timeout	query		integer int32	Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
client-request-id		string uuid	Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Указывает, должен ли сервер возвращать client-request-id в ответе.
ocp-date		string date-time-rfc1123	Время отправки запроса. Клиентские библиотеки обычно устанавливают текущее системное время; Задайте его явным образом, если вы вызываете REST API напрямую.
If-Match		string	Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match		string	Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
If-Modified-Since		string date-time-rfc1123	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе был изменен с указанного времени.
If-Unmodified-Since		string date-time-rfc1123	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе не был изменен с указанного времени.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос к пакетной службе выполнен успешно. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Безопасность

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

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

Scopes

Имя	Описание
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

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

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.

BatchError

Ответ об ошибке, полученный от службы пакетная служба Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	ErrorMessage	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ об ошибке.

ErrorMessage

Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.

Имя	Тип	Описание
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.