Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ServiceBusSessionReceiver.GetSessionStateAsync(CancellationToken) Method

Definition

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

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.

Gets the session state.

public virtual System.Threading.Tasks.Task<BinaryData> GetSessionStateAsync(System.Threading.CancellationToken cancellationToken = default);
abstract member GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>
override this.GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>
Public Overridable Function GetSessionStateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of BinaryData)

Parameters

cancellationToken
CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

The session state as BinaryData.

Exceptions

The lock for the session has expired. The Reason will be set to SessionLockLost in this case.

Applies to


Feedback

Was this page helpful?