ProcessMessageEventArgs.AbandonMessageAsync メソッド

  • リファレンス

定義

名前空間:
Azure.Messaging.ServiceBus
アセンブリ:
Azure.Messaging.ServiceBus.dll
パッケージ:
Azure.Messaging.ServiceBus v7.17.5
パッケージ:
Azure.Messaging.ServiceBus v7.18.0-beta.1
ソース:
ProcessMessageEventArgs.cs
ソース:
ProcessMessageEventArgs.cs

を破棄します ServiceBusReceivedMessage。これにより、受信側が保持するメッセージのロックが解除されるため、メッセージをすぐに処理できるようになります。

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

パラメーター

message
ServiceBusReceivedMessage

ServiceBusReceivedMessage破棄する 。

propertiesToModify
IDictionary<String,Object>

メッセージの破棄中に変更するメッセージのプロパティ。

cancellationToken
CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。

戻り値

Task

操作が完了したときに解決されるタスク。

例外

ServiceBusException
  • メッセージのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティには適用されません。 Reasonこの場合、 は にMessageLockLost設定されます。
  • セッションのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティにのみ適用されます。 Reasonこの場合、 は にSessionLockLost設定されます。

注釈

メッセージを破棄すると、メッセージの配信数が増えます。 この操作は、 が にPeekLock設定されている場合ReceiveModeに、この受信者によって受信されたメッセージに対してのみ実行できます。

適用対象