DataLakeLeaseClient.ChangeAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.21.0

Source:

DataLakeLeaseClient.cs

The ChangeAsync(String, RequestConditions, CancellationToken) operation changes the lease of an active lease. A change must include the current LeaseId and a new proposedId.

For more information, see Lease Container.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>> ChangeAsync (string proposedId, Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ChangeAsync : string * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>>
override this.ChangeAsync : string * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>>

Public Overridable Function ChangeAsync (proposedId As String, Optional conditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataLakeLease))

Parameters

proposedId

String

An optional proposed lease ID, in a GUID string format. A RequestFailedException will be thrown if the proposed lease ID is not in the correct format.

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

Task<Response<DataLakeLease>>

A Response<T> describing the lease.

Remarks

A RequestFailedException will be thrown if a failure occurs.