SubscriptionClient.DeadLetterAsync Method

Definition

Namespace:: Microsoft.ServiceBus.Messaging

Assembly:: Microsoft.ServiceBus.dll

Package:: WindowsAzure.ServiceBus v6.2.2

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.

Overloads

DeadLetterAsync(Guid, String, String)	Asynchronously moves the undelivered message to the dead letter queue.
DeadLetterAsync(Guid)	Asynchronously moves the undelivered message to the dead letter queue.
DeadLetterAsync(Guid, IDictionary<String,Object>)	Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid, String, String)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync(Guid lockToken, string deadLetterReason, string deadLetterErrorDescription);

abstract member DeadLetterAsync : Guid * string * string -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid * string * string -> System.Threading.Tasks.Task

Public Function DeadLetterAsync (lockToken As Guid, deadLetterReason As String, deadLetterErrorDescription As String) As Task

Parameters

lockToken: System.Guid

The lock token bound to the locked message instance.

deadLetterReason: System.String

The reason for deadlettering the message.

deadLetterErrorDescription: System.String

The error description for deadlettering the message.

Returns

System.Threading.Tasks.Task

A task instance that represents the asynchronous deadletter operation.

Applies to

DeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync(Guid lockToken);

abstract member DeadLetterAsync : Guid -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid -> System.Threading.Tasks.Task

Public Function DeadLetterAsync (lockToken As Guid) As Task

Parameters

lockToken: System.Guid

The lock token bound to the locked message instance.

Returns

System.Threading.Tasks.Task

A task instance that represents the asynchronous deadletter operation.

Applies to

DeadLetterAsync(Guid, IDictionary<String,Object>)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync(Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);

abstract member DeadLetterAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task

Public Function DeadLetterAsync (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object)) As Task

Parameters

lockToken: System.Guid

The lock token bound to the locked message instance.

propertiesToModify: System.Collections.Generic.IDictionary<System.String,System.Object>

The properties to modify.

Returns

System.Threading.Tasks.Task

A task instance that represents the asynchronous deadletter operation.

Applies to