ILeaseManager.AcquireLeaseAsync(Lease) Method

  • Reference

Definition

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

Acquire the lease on the desired partition for this EventProcessorHost.

Note that it is legal to acquire a lease that is already owned by another host. Lease-stealing is how partitions are redistributed when additional hosts are started.

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

Parameters

lease
Lease

Lease info for the desired partition as previously obtained from GetLeaseAsync()

Returns

Task<Boolean>

true if the lease was acquired successfully, false if not

Applies to