BlobLeaseClient.Renew(RequestConditions, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.22.2

Source:

BlobLeaseClient.cs

The Renew(RequestConditions, CancellationToken) operation renews the blob or container's previously-acquired lease.

The lease can be renewed if the leaseId matches that associated with the blob or container. Note that the lease may be renewed even if it has expired as long as the blob or container 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.Blobs.Models.BlobLease> Renew (Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Renew : Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobLease>
override this.Renew : Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobLease>

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

Parameters

conditions

RequestConditions

Optional BlobLeaseRequestConditions to add conditions on renewing a lease.

cancellationToken

CancellationToken

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

Returns

Response<BlobLease>

A Response<T> describing the lease.

Remarks

A RequestFailedException will be thrown if a failure occurs.