Share via


EventHubBufferedProducerClient.GetPartitionPropertiesAsync Method

Definition

Retrieves information about a specific partition for an Event Hub, including elements that describe the available events in the partition event stream.

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

Parameters

partitionId
String

The unique identifier of a partition associated with the Event Hub.

cancellationToken
CancellationToken

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

Returns

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

Applies to