ServiceBusReceiver.AbandonMessageAsync Method

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.18.2

Package:: Azure.Messaging.ServiceBus v7.18.0-beta.1

Source:: ServiceBusReceiver.cs

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

Abandons a ServiceBusReceivedMessage.This will make the message available again for immediate processing as the lock on the message held by the receiver will be released.

public virtual System.Threading.Tasks.Task AbandonMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function AbandonMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

message: ServiceBusReceivedMessage

The ServiceBusReceivedMessage to abandon.

propertiesToModify: IDictionary<String,Object>

The properties of the message to modify while abandoning the message.

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

Abandoning a message will increase the delivery count on the message. This operation can only be performed on messages that were received by this receiver when ReceiveMode is set to PeekLock.

Applies to

Share via