BlobLeaseClient.ReleaseAsync(RequestConditions, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.19.1

Source:

BlobLeaseClient.cs

The ReleaseAsync(RequestConditions, CancellationToken) operation releases the container or blob's previously-acquired lease.

The lease may be released if the LeaseId matches that associated with the container or blob. Releasing the lease allows another client to immediately acquire the lease for the container or blob as soon as the release is complete.

For more information, see Lease Container.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.ReleasedObjectInfo>> ReleaseAsync (Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReleaseAsync : Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.ReleasedObjectInfo>>
override this.ReleaseAsync : Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.ReleasedObjectInfo>>

Public Overridable Function ReleaseAsync (Optional conditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ReleasedObjectInfo))

Parameters

conditions

RequestConditions

Optional BlobLeaseRequestConditions to add conditions on releasing a lease.

cancellationToken

CancellationToken

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

Returns

Task<Response<ReleasedObjectInfo>>

A Response<T> describing the updated blob or container.

Remarks

A RequestFailedException will be thrown if a failure occurs.