Share via

PartitionReceiver.GetPartitionPropertiesAsync(CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Messaging.EventHubs.Primitives
Assembly:
Azure.Messaging.EventHubs.dll
Package:
Azure.Messaging.EventHubs v5.11.5
Package:
Azure.Messaging.EventHubs v5.12.0-beta.1
Source:
PartitionReceiver.cs
Source:
PartitionReceiver.cs

Retrieves information about the partition this client is associated to, including elements that describe the available events in the partition event stream.

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

Parameters

cancellationToken
CancellationToken

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

Returns

Task<PartitionProperties>

The set of information for the associated partition under the Event Hub this client is associated with.

Applies to