EventHubConsumerClient class

Balíček:

@azure/event-hubs

Třída se EventHubConsumerClient používá k využívání událostí z centra událostí.

Existuje několik způsobů, jak vytvořit EventHubConsumerClient

• Použijte připojovací řetězec ze zásady SAS vytvořené pro vaši instanci centra událostí.
• Použijte připojovací řetězec ze zásady SAS vytvořené pro váš obor názvů centra událostí a název instance centra událostí.
• Použijte úplný obor názvů, jako je <yournamespace>.servicebus.windows.net, a objekt přihlašovacích údajů.

Volitelně můžete také předat:

• Sada možností pro konfiguraci zásad opakování nebo nastavení proxy serveru.
• Úložiště kontrolních bodů, které klient používá ke čtení kontrolních bodů k určení pozice, odkud by měl obnovit příjem událostí při restartování aplikace. Úložiště kontrolních bodů také klient používá k vyrovnávání zatížení několika instancí vaší aplikace.

Konstruktory

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)	Třída EventHubConsumerClient se používá ke zpracování událostí z centra událostí. options Ke konfiguraci zásad opakování nebo nastavení proxy serveru použijte parmetr.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)	Třída EventHubConsumerClient se používá ke zpracování událostí z centra událostí. options Ke konfiguraci zásad opakování nebo nastavení proxy serveru použijte parmetr.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)	Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)	Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)	Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)	Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.

Vlastnosti

defaultConsumerGroupName	Název výchozí skupiny příjemců ve službě Event Hubs.
eventHubName	Název instance centra událostí, pro kterou je tento klient vytvořen.
fullyQualifiedNamespace	Plně kvalifikovaný obor názvů instance centra událostí, pro kterou je tento klient vytvořen. Je pravděpodobné, že se bude podobat .servicebus.windows.net.
identifier	Název použitý k identifikaci tohoto EventHubConsumerClient. Pokud není zadán nebo prázdný, vygeneruje se náhodný jedinečný.

Metody

close()	Ukončí připojení AMQP k instanci centra událostí a vrátí příslib, který se vyřeší po dokončení odpojení.
getEventHubProperties(GetEventHubPropertiesOptions)	Poskytuje informace o modulu runtime centra událostí.
getPartitionIds(GetPartitionIdsOptions)	Poskytuje ID pro každý oddíl přidružený k centru událostí.
getPartitionProperties(string, GetPartitionPropertiesOptions)	Poskytuje informace o stavu zadaného oddílu.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)	Přihlaste se k odběru událostí z jednoho oddílu. Voláním příkazu close() u vráceného objektu zastavíte příjem událostí. Příklad použití: 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)	Přihlaste se k odběru událostí ze všech oddílů. Pokud je k dispozici EventHubConsumerClient úložiště kontrolních bodů a existuje více instancí vaší aplikace, pak se každá instance přihlásí k odběru podmnožiny oddílů tak, aby se mezi nimi vyrovnávalo zatížení. Voláním příkazu close() u vráceného objektu zastavíte příjem událostí. Příklad použití: 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 } );

Podrobnosti konstruktoru

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Třída EventHubConsumerClient se používá ke zpracování událostí z centra událostí. options Ke konfiguraci zásad opakování nebo nastavení proxy serveru použijte parmetr.

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

Parametry

consumerGroup

string

Název skupiny uživatelů, ze které chcete zpracovávat události.

connectionString

string

Připojovací řetězec, který se má použít pro připojení k instanci centra událostí. Očekává se, že tento připojovací řetězec obsahuje vlastnosti sdíleného klíče a cestu k centru událostí. např. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore

CheckpointStore

Úložiště kontrolních bodů, které klient používá ke čtení kontrolních bodů k určení pozice, odkud by měl obnovit příjem událostí při restartování aplikace. Používá ho také klient k vyrovnávání zatížení několika instancí vaší aplikace.

options

EventHubConsumerClientOptions

Sada možností, které se použijí při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace na klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje kanálování připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se připojí k integrovanému řetězci uživatelského agenta, který se předá službě.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

Třída EventHubConsumerClient se používá ke zpracování událostí z centra událostí. options Ke konfiguraci zásad opakování nebo nastavení proxy serveru použijte parmetr.

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

Parametry

consumerGroup

string

Název skupiny uživatelů, ze které chcete zpracovávat události.

connectionString

string

Připojovací řetězec, který se má použít pro připojení k instanci centra událostí. Očekává se, že tento připojovací řetězec obsahuje vlastnosti sdíleného klíče a cestu k centru událostí. např. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options

EventHubConsumerClientOptions

Sada možností, které se použijí při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace na klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje kanálování připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se připojí k integrovanému řetězci uživatelského agenta, který se předá službě.

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

Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.

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

Parametry

consumerGroup

string

Název skupiny příjemců, ze které chcete zpracovávat události.

connectionString

string

Připojovací řetězec, který se má použít pro připojení k oboru názvů služby Event Hubs. Očekává se, že vlastnosti sdíleného klíče jsou obsaženy v tomto připojovacím řetězci, ale ne v cestě k centru událostí, například Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Název konkrétního centra událostí, ke kterému se má klient připojit.

checkpointStore

CheckpointStore

Úložiště kontrolních bodů, které klient používá ke čtení kontrolních bodů k určení pozice, odkud by měl obnovit příjem událostí při restartování aplikace. Klient ho také používá k vyrovnávání zatížení několika instancí vaší aplikace.

options

EventHubConsumerClientOptions

Sada možností, které se mají použít při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace v klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje channeling připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který je předán službě.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.

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

Parametry

consumerGroup

string

Název skupiny příjemců, ze které chcete zpracovávat události.

connectionString

string

Připojovací řetězec, který se má použít pro připojení k oboru názvů služby Event Hubs. Očekává se, že vlastnosti sdíleného klíče jsou obsaženy v tomto připojovacím řetězci, ale ne v cestě k centru událostí, například Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Název konkrétního centra událostí, ke kterému se má klient připojit.

options

EventHubConsumerClientOptions

Sada možností, které se mají použít při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace v klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje channeling připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který je předán službě.

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

Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.

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

Parametry

consumerGroup

string

Název skupiny příjemců, ze které chcete zpracovávat události.

fullyQualifiedNamespace

string

Úplný obor názvů, který se bude pravděpodobně podobat .servicebus.windows.net

eventHubName

string

Název konkrétního centra událostí, ke kterému se má klient připojit.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objekt přihlašovacích údajů, který klient používá k získání tokenu pro ověření připojení ke službě Azure Event Hubs. Informace o vytváření přihlašovacích údajů, které podporují ověřování AAD, najdete v tématu @azure/identity. AzureNamedKeyCredential Pokud chcete předat SharedAccessKeyNameSharedAccessKey a bez použití připojovacího řetězce, použijte příkaz from @azure/core-auth. Tato pole se mapují na name pole a key v AzureNamedKeyCredentialuvedeném pořadí . AzureSASCredential Pokud chcete předat SharedAccessSignature soubor bez použití připojovacího řetězce, použijte @azure/core-auth. Toto pole se mapuje na signature v AzureSASCredentialsouboru .

checkpointStore

CheckpointStore

Úložiště kontrolních bodů, které klient používá ke čtení kontrolních bodů k určení pozice, odkud by měl obnovit příjem událostí při restartování aplikace. Klient ho také používá k vyrovnávání zatížení několika instancí vaší aplikace.

options

EventHubConsumerClientOptions

Sada možností, které se mají použít při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace v klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje channeling připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který je předán službě.

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

Třída se EventHubConsumerClient používá k využívání událostí z centra událostí. Pomocí parmetru options nakonfigurujte zásady opakování nebo nastavení proxy serveru.

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

Parametry

consumerGroup

string

Název skupiny příjemců, ze které chcete zpracovávat události.

fullyQualifiedNamespace

string

Úplný obor názvů, který se bude pravděpodobně podobat .servicebus.windows.net

eventHubName

string

Název konkrétního centra událostí, ke kterému se má klient připojit.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objekt přihlašovacích údajů, který klient používá k získání tokenu pro ověření připojení ke službě Azure Event Hubs. Informace o vytváření přihlašovacích údajů, které podporují ověřování AAD, najdete v tématu @azure/identity. AzureNamedKeyCredential Pokud chcete předat SharedAccessKeyNameSharedAccessKey a bez použití připojovacího řetězce, použijte příkaz from @azure/core-auth. Tato pole se mapují na name pole a key v AzureNamedKeyCredentialuvedeném pořadí . AzureSASCredential Pokud chcete předat SharedAccessSignature soubor bez použití připojovacího řetězce, použijte @azure/core-auth. Toto pole se mapuje na signature v AzureSASCredentialsouboru .

options

EventHubConsumerClientOptions

Sada možností, které se mají použít při konfiguraci klienta.

• retryOptions : Nakonfiguruje zásadu opakování pro všechny operace v klientovi. Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguruje channeling připojení AMQP přes webové sokety.
• userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který je předán službě.

Podrobnosti vlastnosti

defaultConsumerGroupName

Název výchozí skupiny příjemců ve službě Event Hubs.

static defaultConsumerGroupName: string

Hodnota vlastnosti

string

eventHubName

Název instance centra událostí, pro kterou je tento klient vytvořen.

string eventHubName

Hodnota vlastnosti

string

fullyQualifiedNamespace

Plně kvalifikovaný obor názvů instance centra událostí, pro kterou je tento klient vytvořen. Je pravděpodobné, že se bude podobat .servicebus.windows.net.

string fullyQualifiedNamespace

Hodnota vlastnosti

string

identifier

Název použitý k identifikaci tohoto EventHubConsumerClient. Pokud není zadán nebo prázdný, vygeneruje se náhodný jedinečný.

identifier: string

Hodnota vlastnosti

string

Podrobnosti metody

close()

Ukončí připojení AMQP k instanci centra událostí a vrátí příslib, který se vyřeší po dokončení odpojení.

function close(): Promise<void>

Návraty

Promise<void>

Slib

getEventHubProperties(GetEventHubPropertiesOptions)

Poskytuje informace o modulu runtime centra událostí.

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

Parametry

options

GetEventHubPropertiesOptions

Sada možností, které se mají použít pro volání operace.

Návraty

Promise<EventHubProperties>

Příslib, který řeší informace o instanci centra událostí.

getPartitionIds(GetPartitionIdsOptions)

Poskytuje ID pro každý oddíl přidružený k centru událostí.

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

Parametry

options

GetPartitionIdsOptions

Sada možností, které se mají použít pro volání operace.

Návraty

Promise<string[]>

Příslib, který se vyřeší s polem řetězců představujícím ID pro každý oddíl přidružený k centru událostí.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Poskytuje informace o stavu zadaného oddílu.

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

Parametry

partitionId

string

ID oddílu, pro který jsou požadovány informace.

options

GetPartitionPropertiesOptions

Sada možností, které se mají použít pro volání operace.

Návraty

Promise<PartitionProperties>

Slib, který se vyřeší s informacemi o stavu oddílu .

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Přihlaste se k odběru událostí z jednoho oddílu. Voláním příkazu close() u vráceného objektu zastavíte příjem událostí.

Příklad použití:

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

Parametry

partitionId

string

ID oddílu, ke které se chcete přihlásit.

handlers

SubscriptionEventHandlers

Obslužné rutiny pro životní cyklus předplatného – inicializace předplatného oddílu, příjem událostí, zpracování chyb a uzavření předplatného oddílu.

options

SubscribeOptions

Konfiguruje způsob přijetí událostí. Nejběžnější jsou maxBatchSize a maxWaitTimeInSeconds , které řídí tok událostí do obslužné rutiny poskytnuté pro příjem událostí a také počáteční pozici. Například { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }.

Návraty

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Přihlaste se k odběru událostí ze všech oddílů.

Pokud je k dispozici EventHubConsumerClient úložiště kontrolních bodů a existuje více instancí vaší aplikace, pak se každá instance přihlásí k odběru podmnožiny oddílů tak, aby se mezi nimi vyrovnávalo zatížení.

Voláním příkazu close() u vráceného objektu zastavíte příjem událostí.

Příklad použití:

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

Parametry

handlers

SubscriptionEventHandlers

Obslužné rutiny pro životní cyklus předplatného – inicializace předplatného na oddíl, příjem událostí, zpracování chyb a uzavření předplatného na oddíl.

options

SubscribeOptions

Konfiguruje způsob přijetí událostí. Nejběžnější jsou maxBatchSize a maxWaitTimeInSeconds , které řídí tok událostí do obslužné rutiny poskytnuté pro příjem událostí a také počáteční pozici. Například { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }.

Návraty

Subscription