Delete File operation immediately removes the file from the storage account.
|Enabled file share protocol||Available|
You can construct the
Delete File request as follows. HTTPS is recommended.
|Method||Request URI||HTTP version|
Replace the path components shown in the request URI with your own, as follows:
||The name of your storage account.|
||The name of your file share.|
||Optional. The path to the parent directory.|
||The name of the file.|
For details on path naming restrictions, see Naming and referencing shares, directories, files, and metadata.
You can specify the following additional parameters in the request URI.
||Optional. The timeout parameter is expressed in seconds. For more information, see Setting timeouts for Azure Files operations.|
The following table describes required and optional request headers.
||Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.|
||Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.|
||Required for all authorized requests. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services.|
||Required if the file has an active lease. Available for version 2019-02-02 and later.|
||Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Files.|
||Optional. Version 2022-11-02 and later. The Boolean value specifies if a trailing dot present in request url should be trimmed or not. For more information, see Naming and referencing shares, directories, files, and metadata.|
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 202 (Accepted). For information about status codes, see Status and error codes.
The response for this operation includes the following headers. The response can also include additional, standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
||This header uniquely identifies the request that was made, and can be used for troubleshooting the request. For more information, see Troubleshooting API operations.|
||Indicates the version of Azure Files used to run the request.|
||A UTC date/time value that indicates the time at which the response was initiated. The service generates this value.|
||You can use this header to troubleshoot requests and corresponding responses. The value of this header is equal to the value of the
Only the account owner can call this operation.
When you successfully delete a file, the file is immediately removed from the storage account's index, and is no longer accessible to clients. The file's data is later removed from the service during garbage collection.
If the file has an active lease, the client must specify a valid lease ID on the request in order to delete it.
If the file is open on an SMB client,
Delete File fails with status code 409 (Conflict) and error code
Delete File isn't supported on a share snapshot, which is a read-only copy of a share. If you attempt to perform this operation on a share snapshot, the service returns error 400 (Invalid Query Parameter Value).