ILeaseManager.UpdateLeaseAsync(Lease) Method

  • Reference

Definition

Namespace:
Microsoft.Azure.EventHubs.Processor
Assembly:
Microsoft.Azure.EventHubs.Processor.dll
Package:
Microsoft.Azure.EventHubs.Processor v4.3.2

Update the store with the information in the provided lease.

It is necessary to currently hold a lease in order to update it. If the lease has been stolen, or expired, or released, it cannot be updated. Updating should renew the lease before performing the update to avoid lease expiration during the process.

public System.Threading.Tasks.Task<bool> UpdateLeaseAsync (Microsoft.Azure.EventHubs.Processor.Lease lease);
abstract member UpdateLeaseAsync : Microsoft.Azure.EventHubs.Processor.Lease -> System.Threading.Tasks.Task<bool>
Public Function UpdateLeaseAsync (lease As Lease) As Task(Of Boolean)

Parameters

lease
Lease

New lease info to be stored

Returns

Task<Boolean>

true if the updated was performed successfully, false if not

Applies to