ShareLeaseClient.ReleaseAsync(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares.Specialized

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.17.1

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareLeaseClient.cs

Source:: ShareLeaseClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The ReleaseAsync(CancellationToken) operation releases the files's previously-acquired lease.

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.FileLeaseReleaseInfo>> ReleaseAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReleaseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.FileLeaseReleaseInfo>>
override this.ReleaseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.FileLeaseReleaseInfo>>

Public Overridable Function ReleaseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FileLeaseReleaseInfo))

Parameters

cancellationToken: CancellationToken

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

Returns

Task<Response<FileLeaseReleaseInfo>>

A Response<T> describing the updated file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to