ProcessMessageEventArgs.CompleteMessageAsync Method

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.17.5

Source:: ProcessMessageEventArgs.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.

Completes a ServiceBusReceivedMessage. This will delete the message from the service.

public virtual System.Threading.Tasks.Task CompleteMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken = default);

abstract member CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CompleteMessageAsync (message As ServiceBusReceivedMessage, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

message: ServiceBusReceivedMessage

The message to complete.

cancellationToken: CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task

A task to be resolved on when the operation has completed.

Exceptions

ServiceBusException

The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The Reason will be set to MessageLockLost in this case.
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The Reason will be set to SessionLockLost in this case.

Remarks

This operation can only be performed on a message that was received by this receiver when ReceiveMode is set to PeekLock.

Applies to