PageBlobClient.UpdateSequenceNumberAsync Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Source:

PageBlobClient.cs

The UpdateSequenceNumberAsync(SequenceNumberAction, Nullable<Int64>, PageBlobRequestConditions, CancellationToken) operation changes the sequence number action and sequenceNumber for this page blob.

For more information, see Set Blob Properties.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.PageBlobInfo>> UpdateSequenceNumberAsync (Azure.Storage.Blobs.Models.SequenceNumberAction action, long? sequenceNumber = default, Azure.Storage.Blobs.Models.PageBlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateSequenceNumberAsync : Azure.Storage.Blobs.Models.SequenceNumberAction * Nullable<int64> * Azure.Storage.Blobs.Models.PageBlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.PageBlobInfo>>
override this.UpdateSequenceNumberAsync : Azure.Storage.Blobs.Models.SequenceNumberAction * Nullable<int64> * Azure.Storage.Blobs.Models.PageBlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.PageBlobInfo>>

Public Overridable Function UpdateSequenceNumberAsync (action As SequenceNumberAction, Optional sequenceNumber As Nullable(Of Long) = Nothing, Optional conditions As PageBlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PageBlobInfo))

Parameters

action

SequenceNumberAction

Specifies how the service should modify the blob's sequence number. Max sets the sequence number to be the higher of the value included with the request and the value currently stored for the blob. Update sets the sequence number to the sequenceNumber value. Increment increments the value of the sequence number by 1. If specifying Increment, do not include the sequenceNumber because that will throw a RequestFailedException.

sequenceNumber

Nullable<Int64>

An updated sequence number of your choosing, if action is Max or Update. The value should not be provided if action is Increment. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues via PageBlobRequestConditions.

conditions

PageBlobRequestConditions

Optional PageBlobRequestConditions to add conditions on updating the sequence number of this page blob.

cancellationToken

CancellationToken

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

Returns

Task<Response<PageBlobInfo>>

A Response<T> describing the updated page blob.

Remarks

A RequestFailedException will be thrown if a failure occurs.