Share via

EventHubConsumerClient.GetEventHubPropertiesAsync(CancellationToken) Method

  • Reference

Definition

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

Retrieves information about the Event Hub that the connection is associated with, including the number of partitions present and their identifiers.

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

Parameters

cancellationToken
CancellationToken

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

Returns

Task<EventHubProperties>

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

Applies to