EventHubConsumerClient class

Paket:

@azure/event-hubs

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å Event Hub-instansen
• Använd det fullständiga namnområdet som <yournamespace>.servicebus.windows.netoch ett autentiseringsuppgifter.

Du kan också skicka:

• En alternativväska för att konfigurera återförsöksprincipen eller proxyinställningarna.
• Ett kontrollpunktslager som används av klienten för att läsa kontrollpunkter för att fastställa varifrån det ska återuppta mottagandet av händelser när programmet startas om. Kontrollpunktsarkivet används också av klienten för att lastbalansera flera instanser av ditt program.

Konstruktorer

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 inställningar för återförsök eller proxy.
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 inställningar för återförsök eller proxy.
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 inställningar för återförsök eller proxy.
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 inställningar för återförsök eller proxy.
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 inställningar för återförsök eller proxy.
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 inställningar för återförsök eller proxy.

Egenskaper

defaultConsumerGroupName	Namnet på standardkonsumentgruppen i Event Hubs-tjänsten.
eventHubName	Namnet på den Event Hub-instans som klienten skapas för.
fullyQualifiedNamespace	Det fullständigt kvalificerade namnområdet för den Event Hub-instans som klienten har skapats för. Detta liknar troligen .servicebus.windows.net.
identifier	Namnet 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.
getEventHubProperties(GetEventHubPropertiesOptions)	Innehåller information om Event Hub-körning.
getPartitionIds(GetPartitionIdsOptions)	Tillhandahåller 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.
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 } );
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 } );

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 inställningar för återförsök eller proxy.

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 delad nyckel och händelsehubbens sökväg finns i den här anslutningssträngen. e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore

CheckpointStore

Ett kontrollpunktslager som används av klienten för att läsa kontrollpunkter för att fastställa varifrån det 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. Till 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 inställningar för återförsök eller proxy.

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 delad nyckel och händelsehubbens sökväg finns i den här anslutningssträngen. e.g. '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. Till 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 inställningar för återförsök eller proxy.

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 sökvägen till händelsehubben, 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 kontrollpunktslager som används av klienten för att läsa kontrollpunkter för att fastställa varifrån det 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. Till 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 inställningar för återförsök eller proxy.

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 sökvägen till händelsehubben, 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. Till 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 inställningar för återförsök eller proxy.

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

TokenCredential | NamedKeyCredential | SASCredential

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. Använd AzureNamedKeyCredential från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Fälten mappas till fältet name respektive key i AzureNamedKeyCredential. Använd AzureSASCredential från @azure/core-auth om du vill skicka in en SharedAccessSignature utan att använda en anslutningssträng. Det här fältet mappar till signature i AzureSASCredential.

checkpointStore

CheckpointStore

Ett kontrollpunktslager som används av klienten för att läsa kontrollpunkter för att fastställa varifrån det 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. Till 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 inställningar för återförsök eller proxy.

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

TokenCredential | NamedKeyCredential | SASCredential

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. Använd AzureNamedKeyCredential från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Fälten mappas till fältet name respektive key i AzureNamedKeyCredential. Använd AzureSASCredential från @azure/core-auth om du vill skicka in en SharedAccessSignature utan att använda en anslutningssträng. Det här fältet mappar 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. Till 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: string

Egenskapsvärde

string

eventHubName

Namnet på den Event Hub-instans som klienten skapas för.

string eventHubName

Egenskapsvärde

string

fullyQualifiedNamespace

Det fullständigt kvalificerade namnområdet för den Event Hub-instans som klienten har skapats för. Detta liknar troligen .servicebus.windows.net.

string fullyQualifiedNamespace

Egenskapsvärde

string

identifier

Namnet som används för att identifiera denna EventHubConsumerClient. Om det inte anges eller är tomt genereras en slumpmässig unik.

identifier: string

Egenskapsvä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 information om Event Hub-körning.

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 för vilken information krävs.

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): Subscription

Parametrar

partitionId

string

ID:t för partitionen som du vill prenumerera på.

handlers

SubscriptionEventHandlers

Hanterare för prenumerationens livscykel – prenumerationsinitiering av partitionen, mottagning 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

Subscription

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): Subscription

Parametrar

handlers

SubscriptionEventHandlers

Hanterare för prenumerationens livscykel – prenumerationsinitiering per partition, mottagning 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 } }

Returer

Subscription