Undelete Blob operation restores the contents and metadata of a soft-deleted blob, and any associated soft-deleted snapshots.
Undelete Blob is supported only on version 2017-07-29 or later.
You can construct the
Undelete Blob request as follows. HTTPS is recommended. Replace myaccount with the name of your storage account.
|PUT 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.
|PUT method request URI||HTTP version|
For more information, see Use Azurite emulator for local Azure Storage development.
You can specify the following additional parameter on the request URI.
Request headers (all blob types)
The following table describes required and optional request headers for all blob types.
||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.|
||Optional. Version 2020-08-04 and later. Only for accounts enabled with hierarchical namespace. The path of the soft-deleted blob to undelete. The format is
||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.|
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 200 (OK). 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.|
||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
Undelete 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
Undelete Blob operation, and the least privileged built-in Azure RBAC role that includes this action:
- Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/write
- 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.
When you undelete a soft-deleted blob, the blob and any associated snapshots are available for operations by using other APIs. When you undelete a blob that isn't soft-deleted or has no soft-deleted snapshots, the operation succeeds without any changes.
Authorize requests to Azure Storage
Status and error codes Delete Blob