EventHubConsumerClient class
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Det finns flera sätt att skapa en EventHubConsumerClient
- Använd anslutningssträngen från SAS-principen som skapats för din Event Hub-instans.
- Använd anslutningssträngen från SAS-principen som skapats för händelsehubbens namnområde och namnet på händelsehubbens instans
- Använd det fullständiga namnområdet, till exempel
<yournamespace>.servicebus.windows.net, och ett objekt för autentiseringsuppgifter.
Du kan också skicka:
- En alternativuppsättning för att konfigurera återförsöksprincipen eller proxyinställningarna.
- Ett kontrollpunktsarkiv som används av klienten för att läsa kontrollpunkter för att fastställa varifrån den ska återuppta mottagandet av händelser när programmet startas om. Kontrollpunktsarkivet används också av klienten för att belastningsbalansera flera instanser av ditt program.
Konstruktorer
| Event |
Klassen |
| Event |
Klassen |
| Event |
Klassen |
| Event |
Klassen |
| Event |
Klassen |
| Event |
Klassen |
Egenskaper
| default |
Namnet på standardkonsumentgruppen i Event Hubs-tjänsten. |
| event |
Namnet på den Händelsehubbinstans som klienten har skapats för. |
| fully |
Det fullständigt kvalificerade namnområdet för den Händelsehubbinstans som klienten har skapats för. Detta liknar troligen .servicebus.windows.net. |
| identifier | Det namn som används för att identifiera denna EventHubConsumerClient. Om det inte anges eller är tomt genereras en slumpmässig unik. |
Metoder
| close() | Stänger AMQP-anslutningen till Event Hub-instansen och returnerar ett löfte som kommer att lösas när frånkopplingen har slutförts. |
| get |
Innehåller händelsehubbens körningsinformation. |
| get |
Tillhandahåller ID:t för varje partition som är associerad med händelsehubben. |
| get |
Innehåller information om tillståndet för den angivna partitionen. |
| subscribe(string, Subscription |
Prenumerera på händelser från en enda partition. Anropa close() på det returnerade objektet för att sluta ta emot händelser. Exempel på användning: |
| subscribe(Subscription |
Prenumerera på händelser från alla partitioner. Om kontrollpunktsarkivet tillhandahålls till Anropa close() på det returnerade objektet för att sluta ta emot händelser. Exempel på användning: |
Konstruktorinformation
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- connectionString
-
string
Anslutningssträngen som ska användas för att ansluta till Event Hub-instansen. Det förväntas att egenskaperna för den delade nyckeln och händelsehubbens sökväg finns i den här anslutningssträngen. t.ex. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- checkpointStore
- CheckpointStore
Ett kontrollpunktsarkiv som används av klienten för att läsa kontrollpunkter för att fastställa varifrån den ska återuppta mottagandet av händelser när programmet startas om. Det används också av klienten för att belastningsutjämning flera instanser av ditt program.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- connectionString
-
string
Anslutningssträngen som ska användas för att ansluta till Event Hub-instansen. Det förväntas att egenskaperna för den delade nyckeln och händelsehubbens sökväg finns i den här anslutningssträngen. t.ex. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- connectionString
-
string
Anslutningssträngen som ska användas för att ansluta till Event Hubs-namnområdet. Det förväntas att egenskaperna för den delade nyckeln finns i den här anslutningssträngen, men inte i händelsehubbens sökväg, t.ex. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Namnet på den specifika händelsehubb som klienten ska anslutas till.
- checkpointStore
- CheckpointStore
Ett kontrollpunktsarkiv som används av klienten för att läsa kontrollpunkter för att fastställa varifrån den ska återuppta mottagandet av händelser när programmet startas om. Det används också av klienten för att belastningsutjämning flera instanser av ditt program.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- connectionString
-
string
Anslutningssträngen som ska användas för att ansluta till Event Hubs-namnområdet. Det förväntas att egenskaperna för den delade nyckeln finns i den här anslutningssträngen, men inte i händelsehubbens sökväg, t.ex. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Namnet på den specifika händelsehubb som klienten ska anslutas till.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- fullyQualifiedNamespace
-
string
Det fullständiga namnområdet som sannolikt liknar .servicebus.windows.net
- eventHubName
-
string
Namnet på den specifika händelsehubb som klienten ska anslutas till.
- credential
Ett autentiseringsobjekt som används av klienten för att hämta token för att autentisera anslutningen till Azure Event Hubs-tjänsten.
Se @azure/identitet för att skapa autentiseringsuppgifter som stöder AAD-autentisering. AzureNamedKeyCredential Använd från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Dessa fält mappas namekey till respektive fält i AzureNamedKeyCredential.
AzureSASCredential Använd från @azure/core-auth om du vill skicka in en SharedAccessSignature utan att använda en anslutningssträng. Det här fältet mappas till signature i AzureSASCredential.
- checkpointStore
- CheckpointStore
Ett kontrollpunktsarkiv som används av klienten för att läsa kontrollpunkter för att fastställa varifrån den ska återuppta mottagandet av händelser när programmet startas om. Det används också av klienten för att belastningsutjämning flera instanser av ditt program.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
Klassen EventHubConsumerClient används för att använda händelser från en händelsehubb.
Använd parmetern options för att konfigurera återförsöksprinciper eller proxyinställningar.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)Parametrar
- consumerGroup
-
string
Namnet på den konsumentgrupp som du vill bearbeta händelser från.
- fullyQualifiedNamespace
-
string
Det fullständiga namnområdet som sannolikt liknar .servicebus.windows.net
- eventHubName
-
string
Namnet på den specifika händelsehubb som klienten ska anslutas till.
- credential
Ett autentiseringsobjekt som används av klienten för att hämta token för att autentisera anslutningen till Azure Event Hubs-tjänsten.
Se @azure/identitet för att skapa autentiseringsuppgifter som stöder AAD-autentisering. AzureNamedKeyCredential Använd från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Dessa fält mappas namekey till respektive fält i AzureNamedKeyCredential.
AzureSASCredential Använd från @azure/core-auth om du vill skicka in en SharedAccessSignature utan att använda en anslutningssträng. Det här fältet mappas till signature i AzureSASCredential.
- options
- EventHubConsumerClientOptions
En uppsättning alternativ som ska användas när klienten konfigureras.
-
retryOptions: Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Exempel:{ "maxRetries": 4 }eller{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets. -
userAgent: En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas till tjänsten.
Egenskapsinformation
defaultConsumerGroupName
Namnet på standardkonsumentgruppen i Event Hubs-tjänsten.
static defaultConsumerGroupName: stringEgenskapsvärde
string
eventHubName
Namnet på den Händelsehubbinstans som klienten har skapats för.
string eventHubNameEgenskapsvärde
string
fullyQualifiedNamespace
Det fullständigt kvalificerade namnområdet för den Händelsehubbinstans som klienten har skapats för. Detta liknar troligen .servicebus.windows.net.
string fullyQualifiedNamespaceEgenskapsvärde
string
identifier
Det namn som används för att identifiera denna EventHubConsumerClient. Om det inte anges eller är tomt genereras en slumpmässig unik.
identifier: stringEgenskapsvärde
string
Metodinformation
close()
Stänger AMQP-anslutningen till Event Hub-instansen och returnerar ett löfte som kommer att lösas när frånkopplingen har slutförts.
function close(): Promise<void>Returer
Promise<void>
Löfte
getEventHubProperties(GetEventHubPropertiesOptions)
Innehåller händelsehubbens körningsinformation.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>Parametrar
- options
- GetEventHubPropertiesOptions
Den uppsättning alternativ som ska tillämpas på åtgärdsanropet.
Returer
Promise<EventHubProperties>
Ett löfte som matchar med information om Event Hub-instansen.
getPartitionIds(GetPartitionIdsOptions)
Tillhandahåller ID:t för varje partition som är associerad med händelsehubben.
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>Parametrar
- options
- GetPartitionIdsOptions
Den uppsättning alternativ som ska tillämpas på åtgärdsanropet.
Returer
Promise<string[]>
Ett löfte som matchar med en matris med strängar som representerar ID:t för varje partition som är associerad med händelsehubben.
getPartitionProperties(string, GetPartitionPropertiesOptions)
Innehåller information om tillståndet för den angivna partitionen.
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>Parametrar
- partitionId
-
string
ID:t för partitionen som information krävs för.
- options
- GetPartitionPropertiesOptions
Den uppsättning alternativ som ska tillämpas på åtgärdsanropet.
Returer
Promise<PartitionProperties>
Ett löfte som matchar med information om partitionens tillstånd .
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
Prenumerera på händelser från en enda partition. Anropa close() på det returnerade objektet för att sluta ta emot händelser.
Exempel på användning:
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): SubscriptionParametrar
- partitionId
-
string
ID:t för partitionen som du vill prenumerera på.
- handlers
- SubscriptionEventHandlers
Hanterare för prenumerationens livscykel – prenumerationsinitiering av partitionen, mottagande av händelser, hanteringsfel och stängning av en prenumeration på partitionen.
- options
- SubscribeOptions
Konfigurerar hur händelser tas emot.
De vanligaste är maxBatchSize och maxWaitTimeInSeconds som styr flödet av händelser till den hanterare som tillhandahålls för att ta emot händelser samt startpositionen. Till exempel { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Returer
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Prenumerera på händelser från alla partitioner.
Om kontrollpunktsarkivet tillhandahålls till EventHubConsumerClient och det finns flera instanser av ditt program prenumererar varje instans på en delmängd av partitionerna så att belastningen balanseras mellan dem.
Anropa close() på det returnerade objektet för att sluta ta emot händelser.
Exempel på användning:
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): SubscriptionParametrar
- handlers
- SubscriptionEventHandlers
Hanterare för prenumerationens livscykel – prenumerationsinitiering per partition, mottagande av händelser, hanteringsfel och stängning av en prenumeration per partition.
- options
- SubscribeOptions
Konfigurerar hur händelser tas emot.
De vanligaste är maxBatchSize och maxWaitTimeInSeconds som styr flödet av händelser till den hanterare som tillhandahålls för att ta emot händelser samt startpositionen. Till exempel { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }