QueueClient.DeadLetterAsync メソッド

定義

オーバーロード

DeadLetterAsync(String, IDictionary<String,Object>)

メッセージを配信不能サブキューに移動します。

DeadLetterAsync(String, String, String)

メッセージを配信不能サブキューに移動します。

DeadLetterAsync(String, IDictionary<String,Object>)

ソース:
QueueClient.cs

メッセージを配信不能サブキューに移動します。

public System.Threading.Tasks.Task DeadLetterAsync (string lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default);
abstract member DeadLetterAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.DeadLetterAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
Public Function DeadLetterAsync (lockToken As String, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing) As Task

パラメーター

lockToken
String

配信不能に対応するメッセージのロック トークン。

propertiesToModify
IDictionary<String,Object>

サブキューへの移動中に変更するメッセージのプロパティ。

戻り値

実装

注釈

ロック トークンは、 が にPeekLock設定されている場合ReceiveModeにのみ、 でLockToken見つけることができます。 配信不能キューからメッセージを受信するには、対応するパスを持つ新しい IMessageReceiverが必要です。 を使用 FormatDeadLetterPath(String) してこれを支援できます。 この操作は、この受信者によって受信されたメッセージに対してのみ実行できます。

適用対象

DeadLetterAsync(String, String, String)

ソース:
QueueClient.cs

メッセージを配信不能サブキューに移動します。

public System.Threading.Tasks.Task DeadLetterAsync (string lockToken, string deadLetterReason, string deadLetterErrorDescription = default);
abstract member DeadLetterAsync : string * string * string -> System.Threading.Tasks.Task
override this.DeadLetterAsync : string * string * string -> System.Threading.Tasks.Task
Public Function DeadLetterAsync (lockToken As String, deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing) As Task

パラメーター

lockToken
String

配信不能に対応するメッセージのロック トークン。

deadLetterReason
String

メッセージを配信不能にした理由。

deadLetterErrorDescription
String

メッセージを配信不能にするためのエラーの説明。

戻り値

実装

注釈

ロック トークンは、 が にPeekLock設定されている場合ReceiveModeにのみ、 でLockToken見つけることができます。 配信不能キューからメッセージを受信するには、対応するパスを持つ新しい IMessageReceiverが必要です。 を使用 FormatDeadLetterPath(String) してこれを支援できます。 この操作は、この受信者によって受信されたメッセージに対してのみ実行できます。

適用対象