EventHubConsumerClient class
La classe EventHubConsumerClient 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 à partir de la stratégie SAP créée pour votre instance Event Hub.
- Utilisez la chaîne de connexion à partir de la stratégie SAP créée pour votre espace de noms Event Hub et le nom de l’instance Event Hub
- Utilisez l’espace de noms complet comme
<yournamespace>.servicebus.windows.netet un objet d’informations d’identification.
Si vous le souhaitez, vous pouvez également passer :
- Un conteneur 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 pour déterminer la position à partir de laquelle il doit reprendre la réception d’événements lorsque votre application est redémarrée. Le magasin de points de contrôle est également utilisé par le client pour équilibrer la charge de plusieurs instances de votre application.
Constructeurs
| Event |
La classe |
| Event |
La classe |
| Event |
La classe |
| Event |
La classe |
| Event |
La classe |
| Event |
La classe |
Propriétés
| default |
Nom du groupe de consommateurs par défaut dans le service Event Hubs. |
| event |
Nom de l’instance Event Hub pour laquelle ce client est créé. |
| fully |
Espace de noms complet de l’instance Event Hub pour laquelle ce client est créé. Il est probable que ce soit similaire à <votrenamespace.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 à l’instance Event Hub, en retournant une promesse qui sera résolue une fois la déconnexion terminée. |
| get |
Fournit les informations du runtime Event Hub. |
| get |
Fournit l’ID de chaque partition associée au hub d’événements. |
| get |
Fournit des informations sur l’état de la partition spécifiée. |
| subscribe(string, Subscription |
S’abonner 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 : |
| subscribe(Subscription |
Abonnez-vous aux événements de toutes les partitions. Si le magasin de points de contrôle est fourni au Appelez close() sur l’objet retourné pour arrêter la réception d’événements. Exemple d’utilisation : |
Détails du constructeur
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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 à l’instance Event Hub. On s’attend à ce que les propriétés de clé partagée et le chemin d’accès du hub d’événements 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 pour déterminer la position à partir de laquelle il doit reprendre la réception d’événements lorsque votre application est redémarrée. 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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
Chaîne de connexion à utiliser pour la connexion à l’instance Event Hub. On s’attend à ce que les propriétés de clé partagée et le chemin d’accès du hub d’événements 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'.
- 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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
Magasin de points de contrôle utilisé par le client pour lire les points de contrôle pour déterminer la position à partir de laquelle il doit reprendre la réception d’événements lorsque votre application est redémarrée. 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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
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.
- 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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
L’espace de noms complet qui est susceptible d’être similaire à votre espace> de <noms.servicebus.windows.net
- eventHubName
-
string
Nom du hub d’événements spécifique auquel connecter le client.
- credential
Objet d’informations d’identification utilisé par le client pour obtenir le jeton pour 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 à partir de @azure/authentification principale si vous souhaitez passer un SharedAccessKeyName et SharedAccessKey sans utiliser de chaîne de connexion. Ces champs sont mappés au champ name et key respectivement dans AzureNamedKeyCredential.
Utilisez le AzureSASCredential à partir de @azure/authentification principale si vous souhaitez passer un SharedAccessSignature sans utiliser de chaîne de connexion. Ce champ est mappé à signature dans AzureSASCredential.
- checkpointStore
- CheckpointStore
Magasin de points de contrôle utilisé par le client pour lire les points de contrôle pour déterminer la position à partir de laquelle il doit reprendre la réception d’événements lorsque votre application est redémarrée. 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
La classe EventHubConsumerClient est utilisée pour consommer des événements à partir d’un hub d’événements.
Utilisez le paramètre options pour configurer les paramètres de stratégie ou de proxy de nouvelle tentative.
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
L’espace de noms complet qui est susceptible d’être similaire à votre espace> de <noms.servicebus.windows.net
- eventHubName
-
string
Nom du hub d’événements spécifique auquel connecter le client.
- credential
Objet d’informations d’identification utilisé par le client pour obtenir le jeton pour 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 à partir de @azure/authentification principale si vous souhaitez passer un SharedAccessKeyName et SharedAccessKey sans utiliser de chaîne de connexion. Ces champs sont mappés au champ name et key respectivement dans AzureNamedKeyCredential.
Utilisez le AzureSASCredential à partir de @azure/authentification principale si vous souhaitez passer un SharedAccessSignature sans utiliser de chaîne de connexion. Ce champ est mappé à signature dans AzureSASCredential.
- 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 via Web Sockets. -
userAgent: chaîne à ajouter à la chaîne d’agent utilisateur intégrée transmise au service.
Détails de la propriété
defaultConsumerGroupName
Nom du groupe de consommateurs par défaut dans le service Event Hubs.
static defaultConsumerGroupName: stringValeur de propriété
string
eventHubName
Nom de l’instance Event Hub pour laquelle ce client est créé.
string eventHubNameValeur de propriété
string
fullyQualifiedNamespace
Espace de noms complet de l’instance Event Hub pour laquelle ce client est créé. Il est probable que ce soit similaire à <votrenamespace.servicebus.windows.net>.
string fullyQualifiedNamespaceValeur 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: stringValeur de propriété
string
Détails de la méthode
close()
Ferme la connexion AMQP à l’instance Event Hub, en retournant une promesse qui sera résolue une fois la déconnexion terminée.
function close(): Promise<void>Retours
Promise<void>
Promesse<nulle>
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 l’instance Event Hub.
getPartitionIds(GetPartitionIdsOptions)
Fournit l’ID de chaque partition associée au hub d’événements.
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 au hub d’événements.
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 les informations sont requises.
- options
- GetPartitionPropertiesOptions
Ensemble d’options à appliquer à l’appel d’opération.
Retours
Promise<PartitionProperties>
Promesse qui résout avec des informations sur l’état de la partition .
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
S’abonner 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 :
import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs";
const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName");
const partitionIds = await client.getPartitionIds();
const subscription = client.subscribe(
partitionIds[0],
{
processEvents: async (events, context) => {
console.log("Received event count: ", events.length);
},
processError: async (err, context) => {
console.log("Error: ", err);
},
},
{ startPosition: earliestEventPosition },
);
function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): SubscriptionParamètres
- partitionId
-
string
ID de la partition à laquelle s’abonner.
- handlers
- SubscriptionEventHandlers
Gestionnaires pour le cycle de vie de l’abonnement : initialisation d’abonnement de la partition, réception d’é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.
La plupart des cas sont maxBatchSize et maxWaitTimeInSeconds qui contrôlent le flux d’événements vers le gestionnaire fourni pour recevoir des événements ainsi que la position de début. Par exemple, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Retours
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Abonnez-vous aux événements de toutes les partitions.
Si le magasin de points de contrôle est fourni au EventHubConsumerClient et qu’il existe plusieurs instances de votre application, chaque instance s’abonne à un sous-ensemble des partitions de sorte 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 :
import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs";
const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName");
const subscription = client.subscribe(
{
processEvents: async (events, context) => {
console.log("Received event count: ", events.length);
},
processError: async (err, context) => {
console.log("Error: ", err);
},
},
{ startPosition: earliestEventPosition },
);
function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): SubscriptionParamè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
Configure la façon dont les événements sont reçus.
La plupart des cas sont maxBatchSize et maxWaitTimeInSeconds qui contrôlent le flux d’événements vers le gestionnaire fourni pour recevoir des événements ainsi que la position de début. Par exemple, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }