DataLakeLeaseClient.Release(RequestConditions, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.17.1

Source:

DataLakeLeaseClient.cs

The Release(RequestConditions, CancellationToken) operation releases the file system or path's previously-acquired lease.

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

For more information, see Lease Container.

public virtual Azure.Response<Azure.Storage.Files.DataLake.Models.ReleasedObjectInfo> Release (Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Release : Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.ReleasedObjectInfo>
override this.Release : Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.ReleasedObjectInfo>

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

Parameters

conditions

RequestConditions

Optional RequestConditions to add conditions on acquiring a lease.

cancellationToken

CancellationToken

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

Returns

Response<ReleasedObjectInfo>

A Response<T> describing the updated path or file system.

Remarks

A RequestFailedException will be thrown if a failure occurs.