QueueClient.CompleteAsync(String) Method

Definition

Completes a Message using its lock token. This will delete the message from the queue.

public System.Threading.Tasks.Task CompleteAsync (string lockToken);
abstract member CompleteAsync : string -> System.Threading.Tasks.Task
override this.CompleteAsync : string -> System.Threading.Tasks.Task
Public Function CompleteAsync (lockToken As String) As Task

Parameters

lockToken
String

The lock token of the corresponding message to complete.

Returns

Implements

Remarks

A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. This operation can only be performed on messages that were received by this client.

Applies to