Share via

ServiceBusReceivedMessage.LockToken Property

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ServiceBusReceivedMessage.cs
Source:
ServiceBusReceivedMessage.cs

Gets the lock token for the current message.

public string LockToken { get; }
member this.LockToken : string
Public ReadOnly Property LockToken As String

Property Value

String

Remarks

The lock token is a reference to the lock that is being held by the broker in ReceiveMode.PeekLock mode. Locks are used to explicitly settle messages as explained in the product documentation in more detail. The token can also be used to pin the lock permanently through the Deferral API and, with that, take the message out of the regular delivery state flow. This property is read-only.

Applies to