PageBlobClient.ClearPages Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Source:

PageBlobClient.cs

The ClearPages(HttpRange, PageBlobRequestConditions, CancellationToken) operation clears one or more pages from the page blob, as specificed by the range.

For more information, see Put Page.

public virtual Azure.Response<Azure.Storage.Blobs.Models.PageInfo> ClearPages (Azure.HttpRange range, Azure.Storage.Blobs.Models.PageBlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ClearPages : Azure.HttpRange * Azure.Storage.Blobs.Models.PageBlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.PageInfo>
override this.ClearPages : Azure.HttpRange * Azure.Storage.Blobs.Models.PageBlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.PageInfo>

Public Overridable Function ClearPages (range As HttpRange, Optional conditions As PageBlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PageInfo)

Parameters

range

HttpRange

Specifies the range of bytes to be cleared. Both the start and end of the range must be specified. For a page clear operation, the page range can be up to the value of the blob's full size. Given that pages must be aligned with 512-byte boundaries, the start of the range must be a modulus of 512 and the end of the range must be a modulus of 512 – 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

conditions

PageBlobRequestConditions

Optional PageBlobRequestConditions to add conditions on clearing pages from this page blob.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Response<PageInfo>

A Response<T> describing the state of the updated pages.

Remarks

A RequestFailedException will be thrown if a failure occurs.