DataLakeLeaseClient.Change Method

Definition

The Change(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 Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease> Change (string proposedId, Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Change : string * Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>
override this.Change : string * Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>
Public Overridable Function Change (proposedId As String, Optional conditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

A Response<T> describing the lease.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to