File - Delete From Compute Node

Service:

Batch Service

API Version:

2023-11-01.18.0

Tar bort den angivna filen från beräkningsnoden.

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-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
filePath	path	True	string	Sökvägen till den fil eller katalog som du vill ta bort.
nodeId	path	True	string	ID:t för beräkningsnoden som du vill ta bort filen från.
poolId	path	True	string	ID:t för poolen som innehåller beräkningsnoden.
api-version	query	True	string	Klient-API-version.
recursive	query		boolean	Om underordnade objekt i en katalog ska tas bort. Om parametern filePath representerar en katalog i stället för en fil kan du ange rekursiv till true för att ta bort katalogen och alla filer och underkataloger i den. Om rekursivt är falskt måste katalogen vara tom, annars misslyckas borttagningen.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera client-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ErrorMessage	Ett felmeddelande som tas emot i ett Azure Batch felsvar.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som tas emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.