v3

latestSwagger 2.0raw.githubusercontent.com2019-08-0676156747.2 KB
Files

Deletes the specified file from the Compute Node.

delete/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Path parameters

poolIdstring required

The ID of the Pool that contains the Compute Node.

nodeIdstring required

The ID of the Compute Node from which you want to delete the file.

filePathstring required

The path to the file or directory that you want to delete.

Query parameters

recursiveboolean

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Response

The request to the Batch service was successful.