QueuePolicy.PoisonMessageDrop Property

[This is prerelease documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Gets or sets the poison message drop endpoint.

Namespace: Microsoft.ServiceBus
Assembly: Microsoft.ServiceBus (in microsoft.servicebus.dll)

Dim instance As QueuePolicy
Dim value As EndpointAddress

value = instance.PoisonMessageDrop

instance.PoisonMessageDrop = value

public EndpointAddress PoisonMessageDrop { get; set; }
/** @property */
public EndpointAddress get_PoisonMessageDrop ()

/** @property */
public void set_PoisonMessageDrop (EndpointAddress value)

public function get PoisonMessageDrop () : EndpointAddress

public function set PoisonMessageDrop (value : EndpointAddress)

Property Value

Returns EndpointAddress. Contains the poison message drop.

This setting is not supported in the current CTP release.

The poison message drop endpoint is used whenever the MaxDequeueRetries limit is reached for a message. At that time, the message is sent to the PoisonMessageDrop endpoint if one is defined for the Queue. The delivery attempt is made only once. The endpoint must be a basic HTTP(S) SOAP 1.2 or SOAP 1.1 endpoint that will accept any message that may sit in the queue. The EndpointAddress may contain an address header collection. The contained headers are added to the outbound message when the message is sent, allowing for storing correlation or simple authentication information to be replayed along with the messages.

The primary usage scenario for the PoisonMessageDrop endpoint is to point to another queue that serves as the poison queue for the current queue. Such compositions may be nested, so that you can introduce a primary and secondary recovery handlers for messages deemed poisonous by the mainstream business logic.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003 , Windows Server 2008, and Windows 2000

Target Platforms