Delete Blob operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.
Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the
Delete Blob operation.
You can construct the
Delete Blob request as follows. HTTPS is recommended. Replace myaccount with the name of your storage account.
|DELETE method request URI||HTTP version|
Emulated storage service URI
When you make a request against the emulated storage service, specify the emulator hostname and Azure Blob Storage port as
127.0.0.1:10000, followed by the emulated storage account name.
|DELETE method request URI||HTTP version|
For more information, see Use Azurite emulator for local Azure Storage development.
You can specify the following additional parameters on the request URI.
||Optional. The snapshot parameter is an opaque
||Optional, version 2019-12-12 and later. The
||Optional, version 2020-02-10 or later. The value of
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. For more information, see Versioning for the Azure Storage services.|
||Required if the blob has an active lease.
To perform this operation on a blob with an active lease, specify the valid lease ID for this header. If a valid lease ID isn't specified on the request, the operation fails with status code 403 (Forbidden).
||Required if the blob has associated snapshots. Specify one of the following options:
Specify this header only for a request against the base blob resource. If this header is specified on a request to delete an individual snapshot, Blob Storage returns status code 400 (Bad Request).
If this header isn't specified on the request and the blob has associated snapshots, Blob Storage returns status code 409 (Conflict).
||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 Blob Storage.|
This operation also supports the use of conditional headers to delete the blob only if a specified condition is met. For more information, see Specifying conditional headers for Blob Storage operations.
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 Blob Storage used to run the request. This header is returned for requests made against version 2009-09-19 and later.|
||For version 2017-07-29 and later, Blob Storage returns
||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
Authorization is required when calling any data access operation in Azure Storage. You can authorize the
Delete Blob operation as described below.
Azure Storage supports using Azure Active Directory (Azure AD) to authorize requests to blob data. With Azure AD, you can use Azure role-based access control (Azure RBAC) to grant permissions to a security principal. The security principal may be a user, group, application service principal, or Azure managed identity. The security principal is authenticated by Azure AD to return an OAuth 2.0 token. The token can then be used to authorize a request against the Blob service.
To learn more about authorization using Azure AD, see Authorize access to blobs using Azure Active Directory.
Listed below are the RBAC action necessary for an Azure AD user, group, or service principal to call the
Delete Blob operation, and the least privileged built-in Azure RBAC role that includes this action:
- Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/delete
- Least privileged built-in role: Storage Blob Data Contributor
To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.
If the blob has an active lease, the client must specify a valid lease ID on the request in order to delete it.
If a blob has a large number of snapshots, it's possible that the
Delete Blob operation will time out. If this happens, the client should retry the request.
For version 2013-08-15 and later, the client can call
Delete Blob to delete uncommitted blobs. An uncommitted blob is a blob that was created with calls to the Put Block operation, but never committed by using the Put Block List operation. For earlier versions, the client must commit the blob first before deleting it.
Soft-delete feature disabled
When a blob is successfully deleted, it's immediately removed from the storage account's index, and it's no longer accessible to clients. The blob's data is later removed from the service during garbage collection.
Soft-delete feature enabled
When a blob is successfully deleted, it's soft-deleted, and it's no longer accessible to clients. Blob Storage retains the blob or snapshot for the number of days specified for the
DeleteRetentionPolicy property of Blob Storage. For information about reading Blob Storage properties, see Set Blob Storage properties.
After the specified number of days, the blob’s data is removed from the service during garbage collection. You can access a soft-deleted blob or snapshot by calling the List Blobs operation and specifying the
You can restore soft-deleted blobs or snapshots by using Undelete Blob. For any other operation on soft-deleted blobs or snapshots, Blob Storage returns error 404 (Resource Not Found).
With version 2020-02-10 and later, you can permanently delete a soft-deleted snapshot or version. To do so, you enable the feature. For more for information, see Set Blob Storage properties.
The storage account must have versioning or snapshots enabled. Soft-delete must also be enabled on the storage account to soft-delete versions or snapshots of blobs in the account. Permanent delete only deletes soft-deleted snapshots or versions.
Storage accounts with permanent delete enabled can use the
deletetype=permanent query parameter to permanently delete a soft-deleted snapshot or deleted blob version.
If the query parameter presents any of the following, Blob Storage returns a 409 error (Conflict):
- The permanent delete feature isn't enabled for the storage account.
- The specified snapshot or version isn't soft-deleted.
Permanent delete also includes a shared access signature permission to permanently delete a blob snapshot or blob version. For more information, see Create a service SAS.
Storage accounts are not charged for
Delete Blob requests.