ProcessMessageEventArgs.CompleteMessageAsync メソッド

  • リファレンス

定義

名前空間:
Azure.Messaging.ServiceBus
アセンブリ:
Azure.Messaging.ServiceBus.dll
パッケージ:
Azure.Messaging.ServiceBus v7.17.5
Source:
ProcessMessageEventArgs.cs

を ServiceBusReceivedMessage完了します。 これにより、サービスからメッセージが削除されます。

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

パラメーター

message
ServiceBusReceivedMessage

完了するメッセージ。

cancellationToken
CancellationToken

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

戻り値

Task

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

例外

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

注釈

この操作は、 が に設定PeekLockされている場合ReceiveModeに、このレシーバーによって受信されたメッセージに対してのみ実行できます。

適用対象