DataLakeLeaseClient.Renew(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 Renew(RequestConditions, CancellationToken) operation renews the path or file system's previously-acquired lease.

The lease can be renewed if the leaseId matches that associated with the path or file system. Note that the lease may be renewed even if it has expired as long as the path or file system has not been leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets.

For more information, see Lease Container.

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

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

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

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<DataLakeLease>

A Response<T> describing the lease.

Remarks

A RequestFailedException will be thrown if a failure occurs.