Delete Blob Immutability Policy

Article
11/07/2023

The Delete Blob Immutability Policy operation deletes the immutability policy on a blob. This operation doesn't update the blob's ETag. This API is available in version 2020-06-12 and later.

Request

You can construct the Delete Blob Immutability Policy request as follows. HTTPS is recommended. Replace myaccount with the name of your storage account, mycontainer with the name of your container, and myblob with the blob name for which the immutability policy will be deleted.

Method	Request URI	HTTP version
`DELETE`	`https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=immutabilityPolicies`	HTTP/1.1

URI parameters

You can specify the following additional parameters on the request URI.

Parameter	Description
`snapshot`	Optional. The snapshot parameter is an opaque `DateTime` value that, when present, specifies the blob snapshot to set the tier on. For more information on working with blob snapshots, see Creating a snapshot of a blob.
`versionid`	Optional for version 2019-12-12 and later. The `versionid` parameter is an opaque `DateTime` value that, when present, specifies the version of the blob to set the tier on.
`timeout`	Optional. The `timeout` parameter is expressed in seconds. For more information, see Setting timeouts for Blob Storage operations.

Request headers

The following table describes required and optional request headers.

Request header	Description
`Authorization`	Required. Specifies the authorization scheme, storage account name, and signature. For more information, see Authorize requests to Azure Storage.
`Date` or `x-ms-date`	Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
`x-ms-version`	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.
`x-ms-client-request-id`	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 set the blob only if a specified condition is met. For more information, see Specifying conditional headers for Blob Storage operations.

Request body

None.

Response

The response includes an HTTP status code and a set of response headers.

Status code

A successful operation returns status code 200 (OK). For information about status codes, see Status and error codes.

Response headers

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.

Response header	Description
`x-ms-request-id`	This header uniquely identifies the request that was made, and can be used for troubleshooting the request. For more information, see Troubleshooting API operations.
`x-ms-version`	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.
`x-ms-client-request-id`	You can use this header to troubleshoot requests and corresponding responses. The value of this header is equal to the value of the `x-ms-client-request-id` header, if it's present in the request. The value is at most 1,024 visible ASCII characters. If the `x-ms-client-request-id` header isn't present in the request, this header won't be present in the response.

Authorization

Authorization is required when calling any data access operation in Azure Storage. You can authorize the Delete Blob Immutability Policy operation as described below.

Important

Microsoft recommends using Microsoft Entra ID with managed identities to authorize requests to Azure Storage. Microsoft Entra ID provides superior security and ease of use compared to Shared Key authorization.

Azure Storage supports using Microsoft Entra ID to authorize requests to blob data. With Microsoft Entra ID, 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 Microsoft Entra ID 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 Microsoft Entra ID, see Authorize access to blobs using Microsoft Entra ID.

Permissions

Listed below are the RBAC action necessary for a Microsoft Entra user, group, managed identity, or service principal to call the Delete Blob Immutability Policy operation, and the least privileged built-in Azure RBAC role that includes this action:

Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/immutableStorage/runAsSuperUser/action
Least privileged built-in role: Storage Blob Data Owner

To learn more about assigning roles using Azure RBAC, see Assign an Azure role for access to blob data.

A shared access signature (SAS) provides secure delegated access to resources in a storage account. With a SAS, you have granular control over how a client can access data. You can specify what resource the client may access, what permissions they have to those resources, and how long the SAS is valid.

The Delete Blob Immutability Policy operation supports three types of shared access signatures: user delegation SAS, service SAS, and account SAS.

As a security best practice, we recommend that you use Microsoft Entra credentials rather than the storage account key, which can be more easily compromised. If your application design requires shared access signatures, use Microsoft Entra credentials to create a user delegation SAS, when possible.

When Shared Key access is disallowed for the storage account, a service SAS token or an account SAS token will not be permitted on a request to Blob Storage. To learn more, see Understand how disallowing Shared Key affects SAS tokens.

User delegation SAS

A user delegation SAS is secured with Microsoft Entra credentials and also by the permissions specified for the SAS.

Calling the Delete Blob Immutability Policy operation using a SAS token delegated to a container or blob resource requires the Immutable storage (i) permission as part of the user delegation SAS token.

To learn more about the user delegation SAS, see Create a user delegation SAS.

Service SAS

A service SAS is secured with the storage account key. A service SAS delegates access to a resource in a single Azure Storage service, such as blob storage.

Calling the Delete Blob Immutability Policy operation using a SAS token delegated to a container or blob resource requires the Immutable storage (i) permission as part of the service SAS token.

To learn more about the service SAS, see Create a service SAS.

Account SAS

An account SAS is secured with the storage account key. An account SAS delegates access to resources in one or more of the storage services. All of the operations available via a service or user delegation SAS are also available via an account SAS.

The following table indicates the signed resource type and signed permissions to specify when delegating access:

Operation	Signed service	Signed resource type	Signed permission
Delete Blob Immutability Policy	Blob (b)	Object (o)	Immutable storage (i)

To learn more about the account SAS, see Create an account SAS.

Remarks

Note the following if you delete the blob's immutability policy on Blob Storage or on a general purpose v2 account:

Deleting the immutability policy on a snapshot or a version is allowed with version 2020-06-12 and later.
The immutability policy must be in unlocked mode to be deleted.

For more information, see Immutable storage.

Billing

Pricing requests can originate from clients that use Blob Storage APIs, either directly through the Blob Storage REST API, or from an Azure Storage client library. These requests accrue charges per transaction. The type of transaction affects how the account is charged. For example, read transactions accrue to a different billing category than write transactions. The following table shows the billing category for Delete Blob Immutability Policy requests based on the storage account type:

Operation	Storage account type	Billing category
Delete Blob Immutability Policy	Premium block blob Standard general-purpose v2 Standard general-purpose v1	Other operations

To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.

Share via