IDurableOrchestrationContext.LockAsync(EntityId[]) Method

Reference

Definition

Namespace:: Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Source:: IDurableOrchestrationContext.cs

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.

Acquires one or more locks, for the specified entities.

public System.Threading.Tasks.Task<IDisposable> LockAsync (params Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId[] entities);

abstract member LockAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId[] -> System.Threading.Tasks.Task<IDisposable>

Public Function LockAsync (ParamArray entities As EntityId()) As Task(Of IDisposable)

Parameters

entities: EntityId[]

The entities whose locks should be acquired.

Returns

Task<IDisposable>

An IDisposable that releases the lock when disposed.

Exceptions

LockingRulesViolationException

if the context already holds some locks.

Remarks

Locks can only be acquired if the current context does not hold any locks already.

Applies to