File - Delete From Compute Node

Service:

Batch Service

API Version:

2023-11-01.18.0

Удаляет указанный файл из вычислительного узла.

DELETE {batchUrl}/pools/{poolId}/nodes/{nodeId}/files/{filePath}?api-version=2023-11-01.18.0

With optional parameters:

DELETE {batchUrl}/pools/{poolId}/nodes/{nodeId}/files/{filePath}?recursive={recursive}&timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех пакетная служба Azure запросов на обслуживание.
filePath	path	True	string	Путь к файлу или каталогу, которые требуется удалить.
nodeId	path	True	string	Идентификатор вычислительного узла, из которого требуется удалить файл.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string	Версия API клиента.
recursive	query		boolean	Следует ли удалять дочерние элементы каталога. Если параметр filePath представляет каталог, а не файл, можно задать для параметра recursive значение true, чтобы удалить каталог и все файлы и подкаталоги в нем. Если рекурсивное значение false, каталог должен быть пустым, иначе удаление завершится ошибкой.
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 напрямую.

Ответы

Имя	Тип	Описание
200 OK		Запрос к пакетной службе выполнен успешно. 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

Примеры

File delete from node

Sample Request

HTTP

DELETE account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files/workitems\jobId\job-1\task1\wd\testFile.txt?recursive=False&api-version=2023-11-01.18.0

Sample Response

Status code:

200

Определения

Имя	Описание
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	Текст сообщения.