File - Delete From Compute Node

Service:

Batch Service

API Version:

2023-11-01.18.0

Exclui o arquivo especificado do Nó de Computação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
filePath	path	True	string	O caminho para o arquivo ou diretório que você deseja excluir.
nodeId	path	True	string	A ID do Nó de Computação do qual você deseja excluir o arquivo.
poolId	path	True	string	A ID do pool que contém o Nó de Computação.
api-version	query	True	string	Versão da API do cliente.
recursive	query		boolean	Se deseja excluir filhos de um diretório. Se o parâmetro filePath representar um diretório em vez de um arquivo, você poderá definir recursivo como true para excluir o diretório e todos os arquivos e subdiretórios nele. Se recursivo for false, o diretório deverá estar vazio ou a exclusão falhará.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome	Tipo	Description
200 OK		A solicitação para o serviço do Lote foi bem-sucedida. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Nome	Description
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.

BatchError

Uma resposta de erro recebida do serviço Lote do Azure.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.

Nome	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas na resposta de erro.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.