EventHubConsumerClient class

Référence

Paquet:: @azure/event-hubs

La EventHubConsumerClient classe est utilisée pour consommer des événements à partir d’un hub d’événements.

Il existe plusieurs façons de créer un EventHubConsumerClient

Utilisez la chaîne de connexion de la stratégie SAP créée pour votre instance Event Hub.
Utilisez la chaîne de connexion de la stratégie SAS créée pour votre espace de noms Event Hub, ainsi que le nom du hub d’événements instance
Utilisez l’espace de noms complet comme <yournamespace>.servicebus.windows.net, et un objet d’informations d’identification.

Si vous le souhaitez, vous pouvez également réussir :

Un sac d’options pour configurer la stratégie de nouvelle tentative ou les paramètres de proxy.
Magasin de points de contrôle utilisé par le client pour lire les points de contrôle afin de déterminer la position à partir de laquelle il doit reprendre la réception des événements lors du redémarrage de votre application. Le magasin de points de contrôle est également utilisé par le client pour équilibrer la charge de plusieurs instances de votre application.

Constructeurs

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.
EventHubConsumerClient(string, string, string, TokenCredential \| NamedKeyCredential \| SASCredential, CheckpointStore, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.
EventHubConsumerClient(string, string, string, TokenCredential \| NamedKeyCredential \| SASCredential, EventHubConsumerClientOptions)	La `EventHubConsumerClient` classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur `options` pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.

Propriétés

defaultConsumerGroupName	Nom du groupe de consommateurs par défaut dans le service Event Hubs.
eventHubName	Nom du hub d’événements instance pour lequel ce client est créé.
fullyQualifiedNamespace	Espace de noms complet du instance Event Hub pour lequel ce client est créé. Cela est susceptible d’être similaire à .servicebus.windows.net.
identifier	Nom utilisé pour identifier cet EventHubConsumerClient. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

Méthodes

close()	Ferme la connexion AMQP au instance Event Hub, renvoyant une promesse qui sera résolue une fois la déconnexion terminée.
getEventHubProperties(GetEventHubPropertiesOptions)	Fournit les informations du runtime Event Hub.
getPartitionIds(GetPartitionIdsOptions)	Fournit l’ID de chaque partition associée à Event Hub.
getPartitionProperties(string, GetPartitionPropertiesOptions)	Fournit des informations sur l’état de la partition spécifiée.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)	Abonnez-vous aux événements à partir d’une seule partition. Appelez close() sur l’objet retourné pour arrêter la réception d’événements. Exemple d'utilisation : `const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName); const subscription = client.subscribe( partitionId, { processEvents: (events, context) => { console.log("Received event count: ", events.length) }, processError: (err, context) => { console.log("Error: ", err) } }, { startPosition: earliestEventPosition } );`
subscribe(SubscriptionEventHandlers, SubscribeOptions)	Abonnez-vous aux événements de toutes les partitions. Si le `EventHubConsumerClient` magasin de points de contrôle est fourni au et qu’il existe plusieurs instances de votre application, chaque instance s’abonnera à un sous-ensemble des partitions afin que la charge soit équilibrée entre elles. Appelez close() sur l’objet retourné pour arrêter la réception d’événements. Exemple d'utilisation : `const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName); const subscription = client.subscribe( { processEvents: (events, context) => { console.log("Received event count: ", events.length) }, processError: (err, context) => { console.log("Error: ", err) } }, { startPosition: earliestEventPosition } );`

Détails du constructeur

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe est utilisée pour consommer des événements à partir d’un hub d’événements. Utilisez l’analyseur options pour configurer les paramètres de stratégie de nouvelle tentative ou de proxy.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

connectionString: string

Chaîne de connexion à utiliser pour la connexion au instance Event Hub. Il est attendu que les propriétés de clé partagée et le chemin d’accès Event Hub soient contenus dans cette chaîne de connexion. par exemple, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key ; EntityPath=my-event-hub-name'.

checkpointStore: CheckpointStore

Magasin de points de contrôle utilisé par le client pour lire les points de contrôle afin de déterminer la position à partir de laquelle il doit reprendre la réception des événements lors du redémarrage de votre application. Il est également utilisé par le client pour équilibrer la charge de plusieurs instances de votre application.

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

connectionString: string

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

connectionString: string

Chaîne de connexion à utiliser pour la connexion à l’espace de noms Event Hubs. Il est prévu que les propriétés de clé partagée soient contenues dans cette chaîne de connexion, mais pas dans le chemin d’accès Event Hub, par exemple ' Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name ; SharedAccessKey=my-SA-key;'.

eventHubName: string

Nom du hub d’événements spécifique auquel connecter le client.

checkpointStore: CheckpointStore

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

connectionString: string

eventHubName: string

Nom du hub d’événements spécifique auquel connecter le client.

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

fullyQualifiedNamespace: string

Espace de noms complet qui est susceptible d’être similaire à .servicebus.windows.net

eventHubName: string

Nom du hub d’événements spécifique auquel connecter le client.

credential: TokenCredential | NamedKeyCredential | SASCredential

Objet d’informations d’identification utilisé par le client pour obtenir le jeton afin d’authentifier la connexion avec le service Azure Event Hubs. Consultez @azure/identité pour créer des informations d’identification qui prennent en charge l’authentification AAD. Utilisez le AzureNamedKeyCredential de @azure/core-auth si vous souhaitez passer un et SharedAccessKey sans utiliser de SharedAccessKeyName chaîne de connexion. Ces champs sont mappés au name champ et key respectivement dans AzureNamedKeyCredential. Utilisez le AzureSASCredential de @azure/core-auth si vous souhaitez passer un sans utiliser de SharedAccessSignature chaîne de connexion. Ce champ est mappé à signature dans AzureSASCredential.

checkpointStore: CheckpointStore

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

Paramètres

consumerGroup: string

Nom du groupe de consommateurs à partir duquel vous souhaitez traiter les événements.

fullyQualifiedNamespace: string

Espace de noms complet qui est susceptible d’être similaire à .servicebus.windows.net

eventHubName: string

Nom du hub d’événements spécifique auquel connecter le client.

credential: TokenCredential | NamedKeyCredential | SASCredential

options: EventHubConsumerClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.
userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée au service.

Détails de la propriété

defaultConsumerGroupName

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

static defaultConsumerGroupName: string

Valeur de propriété

string

eventHubName

Nom du hub d’événements instance pour lequel ce client est créé.

string eventHubName

Valeur de propriété

string

fullyQualifiedNamespace

Espace de noms complet du instance Event Hub pour lequel ce client est créé. Cela est susceptible d’être similaire à .servicebus.windows.net.

string fullyQualifiedNamespace

Valeur de propriété

string

identifier

Nom utilisé pour identifier cet EventHubConsumerClient. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

identifier: string

Valeur de propriété

string

Détails de la méthode

close()

Ferme la connexion AMQP au instance Event Hub, renvoyant une promesse qui sera résolue une fois la déconnexion terminée.

function close(): Promise<void>

Retours

Promise<void>

Promise

getEventHubProperties(GetEventHubPropertiesOptions)

Fournit les informations du runtime Event Hub.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

Paramètres

options: GetEventHubPropertiesOptions

Ensemble d’options à appliquer à l’appel d’opération.

Retours

Promise<EventHubProperties>

Promesse qui se résout avec des informations sur le instance Event Hub.

getPartitionIds(GetPartitionIdsOptions)

Fournit l’ID de chaque partition associée à Event Hub.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

Paramètres

options: GetPartitionIdsOptions

Ensemble d’options à appliquer à l’appel d’opération.

Retours

Promise<string[]>

Promesse qui se résout avec un tableau de chaînes représentant l’ID de chaque partition associée à Event Hub.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Fournit des informations sur l’état de la partition spécifiée.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

Paramètres

partitionId: string

ID de la partition pour laquelle des informations sont requises.

options: GetPartitionPropertiesOptions

Ensemble d’options à appliquer à l’appel d’opération.

Retours

Promise<PartitionProperties>

Promesse qui se résout avec des informations sur l’état de la partition .

Abonnez-vous aux événements à partir d’une seule partition. Appelez close() sur l’objet retourné pour arrêter la réception d’événements.

Exemple d'utilisation :

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 partitionId,
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

Paramètres

partitionId: string

ID de la partition à laquelle s’abonner.

handlers: SubscriptionEventHandlers

Gestionnaires pour le cycle de vie de l’abonnement : initialisation de l’abonnement de la partition, réception des événements, gestion des erreurs et fermeture d’un abonnement à la partition.

options: SubscribeOptions

Configure la façon dont les événements sont reçus. Les plus courants sont maxBatchSize et maxWaitTimeInSeconds qui contrôlent le flux d’événements vers le gestionnaire fourni pour recevoir les événements, ainsi que la position de début. Par exemple : { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Retours

Subscription

Abonnez-vous aux événements de toutes les partitions.

Si le EventHubConsumerClient magasin de points de contrôle est fourni au et qu’il existe plusieurs instances de votre application, chaque instance s’abonnera à un sous-ensemble des partitions afin que la charge soit équilibrée entre elles.

Appelez close() sur l’objet retourné pour arrêter la réception d’événements.

Exemple d'utilisation :

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

Paramètres

handlers: SubscriptionEventHandlers

Gestionnaires pour le cycle de vie de l’abonnement : initialisation de l’abonnement par partition, réception d’événements, gestion des erreurs et fermeture d’un abonnement par partition.

options: SubscribeOptions

Retours

Subscription

Partager via

EventHubConsumerClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Paramètres

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

Paramètres

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

Paramètres

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

Paramètres

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

Paramètres

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

Paramètres

Détails de la propriété

defaultConsumerGroupName

Valeur de propriété

eventHubName

Valeur de propriété

fullyQualifiedNamespace

Valeur de propriété

identifier

Valeur de propriété

Détails de la méthode

close()

Retours

getEventHubProperties(GetEventHubPropertiesOptions)

Paramètres

Retours

getPartitionIds(GetPartitionIdsOptions)

Paramètres

Retours

getPartitionProperties(string, GetPartitionPropertiesOptions)

Paramètres

Retours

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Paramètres

Retours

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Paramètres

Retours

Ressources supplémentaires