EventHubConsumerClient Classe

Définition

Espace de noms:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Paquet:

Azure.Messaging.EventHubs v5.11.3

Source:

EventHubConsumerClient.cs

Client responsable de la lecture EventData à partir d’un Event Hub spécifique en tant que membre d’un groupe de consommateurs spécifique.

Un consommateur peut être exclusif, ce qui affirme la propriété sur les partitions associées pour le groupe de consommateurs afin de s’assurer qu’un seul consommateur de ce groupe lit le à partir de la partition. Ces consommateurs exclusifs sont parfois appelés « consommateurs d’époque ».

Un consommateur peut également être non exclusif, ce qui permet à plusieurs consommateurs du même groupe de consommateurs de lire activement des événements à partir d’une partition donnée. Ces consommateurs non exclusifs sont parfois appelés « consommateurs hors époque ».

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

Héritage

Object

EventHubConsumerClient

Implémente

IAsyncDisposable

Remarques

Le EventHubConsumerClient est sûr à mettre en cache et à utiliser pendant la durée de vie d’une application, ce qui est la meilleure pratique lorsque l’application lit des événements régulièrement ou semi-régulièrement. Le consommateur est chargé de garantir une utilisation efficace du réseau, du processeur et de la mémoire. CloseAsync(CancellationToken) L’appel ou DisposeAsync() lorsque l’application s’arrête garantit que les ressources réseau et autres objets non managés sont correctement nettoyés.

Constructeurs

EventHubConsumerClient()	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, EventHubConnection, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureNamedKeyCredential, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureSasCredential, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, TokenCredential, EventHubConsumerClientOptions)	Initialise une nouvelle instance de la classe EventHubConsumerClient.

Champs

DefaultConsumerGroupName

Nom du groupe de consommateurs par défaut dans le service Event Hubs.

Propriétés

ConsumerGroup	Nom du groupe de consommateurs auquel ce consommateur est associé. Les événements seront lus uniquement dans le contexte de ce groupe.
EventHubName	Nom du hub d’événements auquel le consommateur est connecté, spécifique à l’espace de noms Event Hubs qui le contient.
FullyQualifiedNamespace	Espace de noms Event Hubs complet auquel le consommateur est associé. Cela est susceptible d’être similaire à {yournamespace}.servicebus.windows.net.
Identifier	Nom unique utilisé pour identifier ce consommateur.
IsClosed	Indique si cette EventHubConsumerClient opération a été fermée ou non.

Méthodes

CloseAsync(CancellationToken)	Ferme le consommateur.
DisposeAsync()	Effectue la tâche nécessaire pour propre ressources utilisées par , EventHubConsumerClientnotamment en s’assurant que le client lui-même a été fermé.
GetEventHubPropertiesAsync(CancellationToken)	Récupère des informations sur le hub d’événements auquel la connexion est associée, notamment le nombre de partitions présentes et leurs identificateurs.
GetPartitionIdsAsync(CancellationToken)	Récupère le jeu d’identificateurs pour les partitions d’un Event Hub.
GetPartitionPropertiesAsync(String, CancellationToken)	Récupère des informations sur une partition spécifique pour un Event Hub, y compris des éléments qui décrivent les événements disponibles dans le flux d’événements de partition.
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	Lit les événements de toutes les partitions du hub d’événements en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.
ReadEventsAsync(CancellationToken)	Lit les événements de toutes les partitions du hub d’événements en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.
ReadEventsAsync(ReadEventOptions, CancellationToken)	Lit les événements de toutes les partitions du hub d’événements en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé d’appeler la surcharge qui accepte un ensemble d’options pour configurer le comportement de lecture pour les scénarios où une période d’attente maximale plus déterministe est souhaitée.
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	Lit les événements de la partition demandée en tant qu’énumérable asynchrone, ce qui permet d’itérer les événements à mesure qu’ils deviennent disponibles sur la partition, en attendant si nécessaire si aucun événement n’est disponible. Cet énumérateur peut bloquer pendant une durée indéterminée pour un await si les événements ne sont pas disponibles sur la partition, ce qui nécessite l’annulation via le à demander pour retourner le cancellationToken contrôle. Il est recommandé de définir le pour les MaximumWaitTime scénarios où une période d’attente maximale plus déterministe est souhaitée.