ILeaseStore.AcquireInitializationLockAsync(TimeSpan) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.ChangeFeedProcessor.LeaseManagement

Assembly:: Microsoft.Azure.Documents.ChangeFeedProcessor.dll

Package:: Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Places a lock on the lease store for initialization. Only one process may own the store for the lock time.

public System.Threading.Tasks.Task<bool> AcquireInitializationLockAsync (TimeSpan lockExpirationTime);

abstract member AcquireInitializationLockAsync : TimeSpan -> System.Threading.Tasks.Task<bool>

Public Function AcquireInitializationLockAsync (lockExpirationTime As TimeSpan) As Task(Of Boolean)

Parameters

lockExpirationTime: TimeSpan

The time for the lock to expire.

Returns

Task<Boolean>

True if the lock was acquired, false otherwise.

Remarks

In order for expiration time work, lease colection needs to have TTL enabled.

Applies to

Share via