File - Delete From Task

Servicio:

Batch Service

Versión de la API:

2024-07-01.20.0

Elimina el archivo de tarea especificado del nodo de proceso donde se ejecutó la tarea.

DELETE {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2024-07-01.20.0

Con parámetros opcionales:

DELETE {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?recursive={recursive}&timeout={timeout}&api-version=2024-07-01.20.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.
filePath	path	True	string	Ruta de acceso al archivo de tarea o directorio que desea eliminar.
jobId	path	True	string	Identificador del trabajo que contiene la tarea.
taskId	path	True	string	Identificador de la tarea cuyo archivo desea eliminar.
api-version	query	True	string	Versión de la API de cliente.
recursive	query		boolean	Si se van a eliminar elementos secundarios de un directorio. Si el parámetro filePath representa un directorio en lugar de un archivo, puede establecer recursivo en true para eliminar el directorio y todos los archivos y subdirectorios en él. Si recursiva es false, el directorio debe estar vacío o se producirá un error en la eliminación.
timeout	query		integer (int32)	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.

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 en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK		La solicitud al servicio Batch se realizó correctamente. Encabezados 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 Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

File delete from task

Solicitud de ejemplo

HTTP

DELETE account.region.batch.azure.com/jobs/jobId/tasks/task1/files/wd\testFile.txt?recursive=False&api-version=2024-07-01.20.0

Respuesta de muestra

status code:

200

Definiciones

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

BatchError

Object

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 contienen detalles adicionales sobre el error.

BatchErrorDetail

Object

Un elemento de información adicional incluida en una respuesta de error de 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

Object

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

Nombre	Tipo	Description
lang	string	El código de idioma del mensaje de error
value	string	El texto del mensaje.