ServiceBusReceiver.DeadLetterMessageAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)
配信不能サブキューにメッセージを移動します。
public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DeadLetterMessageAsync (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 な インスタンス。
戻り値
例外
- メッセージのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティには適用されません。 Reasonこの場合、 は にMessageLockLost設定されます。
- セッションのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティにのみ適用されます。 Reasonこの場合、 は にSessionLockLost設定されます。
注釈
配信不能キューからメッセージを受信したり、配信不能キューを転送したりするには、 または CreateReceiver(String, String, ServiceBusReceiverOptions)を呼び出CreateReceiver(String, ServiceBusReceiverOptions)すときに プロパティを SubQueue または TransferDeadLetter にDeadLetter設定します。 この操作は、 が にPeekLock設定されている場合ReceiveModeにのみ実行できます。
適用対象
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)
配信不能サブキューにメッセージを移動します。
public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- message
- ServiceBusReceivedMessage
ServiceBusReceivedMessage配信不能の 。
- deadLetterReason
- String
メッセージを配信不能にする理由。
- deadLetterErrorDescription
- String
メッセージの配信不能に関するエラーの説明。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
例外
- メッセージのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティには適用されません。 Reasonこの場合、 は にMessageLockLost設定されます。
- セッションのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティにのみ適用されます。 Reasonこの場合、 は にSessionLockLost設定されます。
- 配信不能の理由または配信不能エラーの説明が、最大長の 4096 を超えました。
注釈
配信不能キューからメッセージを受信したり、配信不能キューを転送したりするには、 または CreateReceiver(String, String, ServiceBusReceiverOptions)を呼び出CreateReceiver(String, ServiceBusReceiverOptions)すときに プロパティを SubQueue または TransferDeadLetter にDeadLetter設定します。 この操作は、 が にPeekLock設定されている場合ReceiveModeにのみ実行できます。
適用対象
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, String, String, CancellationToken)
配信不能サブキューにメッセージを移動します。
public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, propertiesToModify As IDictionary(Of String, Object), deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- message
- ServiceBusReceivedMessage
ServiceBusReceivedMessage配信不能の 。
- propertiesToModify
- IDictionary<String,Object>
サブキューへの移動中に変更するメッセージのプロパティ。
- deadLetterReason
- String
メッセージを配信不能にする理由。
- deadLetterErrorDescription
- String
メッセージの配信不能に関するエラーの説明。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
例外
- メッセージのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティには適用されません。 Reasonこの場合、 は にMessageLockLost設定されます。
- セッションのロックの有効期限が切れているか、メッセージが既に完了しています。 これは、セッションが有効なエンティティにのみ適用されます。 Reasonこの場合、 は にSessionLockLost設定されます。
- パラメーターとプロパティ ディクショナリの両方で、配信不能の理由または配信不能エラーの例外が指定されました。
- 配信不能の理由または配信不能エラーの説明が、最大長の 4096 を超えました。
注釈
配信不能キューからメッセージを受信したり、配信不能キューを転送したりするには、 または CreateReceiver(String, String, ServiceBusReceiverOptions)を呼び出CreateReceiver(String, ServiceBusReceiverOptions)すときに プロパティを SubQueue または TransferDeadLetter にDeadLetter設定します。 この操作は、 が にPeekLock設定されている場合ReceiveModeにのみ実行できます。 配信不能の理由とエラーの説明は、メソッド パラメーターを使用するか、このプロパティを使用してハードコーディングする方法でのみ指定できます。
適用対象
Azure SDK for .NET