EventHubConsumerClient class
A EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
Többféleképpen is létrehozható EventHubConsumerClient
- Használja az Event Hub-példányhoz létrehozott SAS-szabályzat kapcsolati sztring.
- Használja az eseményközpont-névtérhez létrehozott SAS-szabályzat kapcsolati sztring és az Event Hub-példány nevét
- Használja a teljes névteret, például
<yournamespace>.servicebus.windows.net
a , és egy hitelesítőadat-objektumot.
Igény szerint a következőket is átadhatja:
- Egy beállításcsomag az újrapróbálkozési szabályzat vagy proxybeállítások konfigurálásához.
- Egy ellenőrzőpont-tároló, amelyet az ügyfél az ellenőrzőpontok olvasására használ annak meghatározására, hogy honnan kell folytatnia az események fogadását az alkalmazás újraindításakor. Az ügyfél az ellenőrzőpont-tárolót is használja az alkalmazás több példányának terheléselosztására.
Konstruktorok
Event |
Az |
Event |
Az |
Event |
A |
Event |
A |
Event |
A |
Event |
A |
Tulajdonságok
default |
Az Event Hubs szolgáltatás alapértelmezett fogyasztói csoportjának neve. |
event |
Annak az Event Hub-példánynak a neve, amelyhez ez az ügyfél létrejön. |
fully |
Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfelet létrehozták. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hez. |
identifier | Az EventHubConsumerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit. |
Metódusok
close() | Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a kapcsolat bontásának befejezésekor megoldódik. |
get |
Az Event Hub futtatókörnyezetének információi. |
get |
Megadja az eseményközponthoz társított partíciók azonosítóját. |
get |
Információt nyújt a megadott partíció állapotáról. |
subscribe(string, Subscription |
Feliratkozás egyetlen partíció eseményeire. Az események fogadásának leállításához hívja meg a close() parancsot a visszaadott objektumon. Példahasználat:
|
subscribe(Subscription |
Feliratkozás az összes partíció eseményeire. Ha az ellenőrzőpont-tároló az Az események fogadásának leállításához hívja meg a close() parancsot a visszaadott objektumon. Példahasználat:
|
Konstruktor adatai
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
Az EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- connectionString
-
string
A kapcsolati sztring az Event Hub-példányhoz való csatlakozáshoz. A megosztott kulcs tulajdonságai és az Event Hub elérési útja várhatóan ebben a kapcsolati sztring található. pl. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name".
- checkpointStore
- CheckpointStore
Egy ellenőrzőpont-tároló, amelyet az ügyfél az ellenőrzőpontok olvasására használ annak meghatározására, hogy az alkalmazás újraindításakor hol kell folytatnia az események fogadását. Az ügyfél az alkalmazás több példányának terheléselosztására is használja.
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
Az EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- connectionString
-
string
A kapcsolati sztring az Event Hub-példányhoz való csatlakozáshoz. A megosztott kulcs tulajdonságai és az Event Hub elérési útja várhatóan ebben a kapcsolati sztring található. pl. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name".
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
A EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- connectionString
-
string
Az Event Hubs-névtérhez való csatlakozáshoz használandó kapcsolati sztring. A megosztott kulcs tulajdonságai várhatóan ebben a kapcsolati sztring találhatók, de az Eseményközpont elérési útja nem, például :Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.
- checkpointStore
- CheckpointStore
Egy ellenőrzőpont-tároló, amelyet az ügyfél az ellenőrzőpontok olvasására használ annak meghatározására, hogy honnan kell folytatnia az események fogadását az alkalmazás újraindításakor. Az ügyfél az alkalmazás több példányának terheléselosztására is használja.
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
A EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- connectionString
-
string
Az Event Hubs-névtérhez való csatlakozáshoz használandó kapcsolati sztring. A megosztott kulcs tulajdonságai várhatóan ebben a kapcsolati sztring találhatók, de az Eseményközpont elérési útja nem, például :Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
A EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- fullyQualifiedNamespace
-
string
A teljes névtér, amely valószínűleg hasonló lesz a .servicebus.windows.net
- eventHubName
-
string
Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.
- credential
-
TokenCredential | NamedKeyCredential | SASCredential
Egy hitelesítőadat-objektum, amelyet az ügyfél használ a jogkivonat lekéréséhez a Azure Event Hubs szolgáltatással való kapcsolat hitelesítéséhez.
Az AAD-hitelesítést támogató hitelesítő adatok létrehozásáról lásd: @azure/identitás. Használja a AzureNamedKeyCredential
from @azure/core-auth értéket, ha kapcsolati sztring használata nélkül szeretne és értéket megadni SharedAccessKey
SharedAccessKeyName
. Ezek a mezők a és key
a name
mezőre vannak képezve a fájlbanAzureNamedKeyCredential
.
Használja a AzureSASCredential
from @azure/core-auth értéket, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessSignature
értéket. Ez a mező a következőre van leképzve signature
: AzureSASCredential
.
- checkpointStore
- CheckpointStore
Egy ellenőrzőpont-tároló, amelyet az ügyfél az ellenőrzőpontok olvasására használ annak meghatározására, hogy honnan kell folytatnia az események fogadását az alkalmazás újraindításakor. Az ügyfél az alkalmazás több példányának terheléselosztására is használja.
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
A EventHubConsumerClient
osztály eseményközpontból származó események felhasználására szolgál.
options
A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)
Paraméterek
- consumerGroup
-
string
Annak a fogyasztói csoportnak a neve, amelyből az eseményeket fel szeretné dolgozni.
- fullyQualifiedNamespace
-
string
A teljes névtér, amely valószínűleg hasonló lesz a .servicebus.windows.net
- eventHubName
-
string
Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.
- credential
-
TokenCredential | NamedKeyCredential | SASCredential
Egy hitelesítőadat-objektum, amelyet az ügyfél használ a jogkivonat lekéréséhez a Azure Event Hubs szolgáltatással való kapcsolat hitelesítéséhez.
Az AAD-hitelesítést támogató hitelesítő adatok létrehozásáról lásd: @azure/identitás. Használja a AzureNamedKeyCredential
from @azure/core-auth értéket, ha kapcsolati sztring használata nélkül szeretne és értéket megadni SharedAccessKey
SharedAccessKeyName
. Ezek a mezők a és key
a name
mezőre vannak képezve a fájlbanAzureNamedKeyCredential
.
Használja a AzureSASCredential
from @azure/core-auth értéket, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessSignature
értéket. Ez a mező a következőre van leképzve signature
: AzureSASCredential
.
- options
- EventHubConsumerClientOptions
Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.
retryOptions
: Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például{ "maxRetries": 4 }
vagy{ "maxRetries": 4, "retryDelayInMs": 30000 }
.webSocketOptions
: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.userAgent
: A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.
Tulajdonság adatai
defaultConsumerGroupName
Az Event Hubs szolgáltatás alapértelmezett fogyasztói csoportjának neve.
static defaultConsumerGroupName: string
Tulajdonság értéke
string
eventHubName
Annak az Event Hub-példánynak a neve, amelyhez ez az ügyfél létrejön.
string eventHubName
Tulajdonság értéke
string
fullyQualifiedNamespace
Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfelet létrehozták. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hez.
string fullyQualifiedNamespace
Tulajdonság értéke
string
identifier
Az EventHubConsumerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.
identifier: string
Tulajdonság értéke
string
Metódus adatai
close()
Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a kapcsolat bontásának befejezésekor megoldódik.
function close(): Promise<void>
Válaszok
Promise<void>
Ígéret
getEventHubProperties(GetEventHubPropertiesOptions)
Az Event Hub futtatókörnyezetének információi.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>
Paraméterek
- options
- GetEventHubPropertiesOptions
A műveleti hívásra alkalmazandó beállítások halmaza.
Válaszok
Promise<EventHubProperties>
Egy ígéret, amely az Event Hub-példányra vonatkozó információkkal oldható fel.
getPartitionIds(GetPartitionIdsOptions)
Megadja az eseményközponthoz társított partíciók azonosítóját.
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>
Paraméterek
- options
- GetPartitionIdsOptions
A műveleti hívásra alkalmazandó beállítások halmaza.
Válaszok
Promise<string[]>
Egy ígéret, amely egy sztringtömbdel oldható fel, amely az Eseményközponthoz társított partíciók azonosítóját jelöli.
getPartitionProperties(string, GetPartitionPropertiesOptions)
Információt nyújt a megadott partíció állapotáról.
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>
Paraméterek
- partitionId
-
string
Annak a partíciónak az azonosítója, amelyhez információ szükséges.
- options
- GetPartitionPropertiesOptions
A műveleti hívásra alkalmazandó beállítások halmaza.
Válaszok
Promise<PartitionProperties>
Egy ígéret, amely a partíció állapotával kapcsolatos információkkal oldható fel.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
Feliratkozás egyetlen partíció eseményeire. Az események fogadásának leállításához hívja meg a close() parancsot a visszaadott objektumon.
Példahasználat:
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éterek
- partitionId
-
string
Annak a partíciónak az azonosítója, amelyre elő szeretne fizetni.
- handlers
- SubscriptionEventHandlers
Az előfizetés életciklusának kezelői – a partíció előfizetés-inicializálása, események fogadása, hibák kezelése és egy előfizetés partícióra való bezárása.
- options
- SubscribeOptions
Konfigurálja az események fogadásának módját.
A leggyakoribbak a maxBatchSize
és maxWaitTimeInSeconds
az, amelyek az események fogadásához megadott kezelőre, valamint az indítási pozícióra irányítják az események áramlását. Például: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Válaszok
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Feliratkozás az összes partíció eseményeire.
Ha az ellenőrzőpont-tároló az EventHubConsumerClient
és az alkalmazásnak több példánya is van, akkor minden példány feliratkozik a partíciók egy részhalmazára, hogy a terhelés kiegyensúlyozott legyen közöttük.
Az események fogadásának leállításához hívja meg a close() parancsot a visszaadott objektumon.
Példahasználat:
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éterek
- handlers
- SubscriptionEventHandlers
Az előfizetés életciklusának kezelői – előfizetés inicializálása partíciónként, események fogadása, hibák kezelése és előfizetés partíciónkénti bezárása.
- options
- SubscribeOptions
Konfigurálja az események fogadásának módját.
A leggyakoribbak a maxBatchSize
és maxWaitTimeInSeconds
az, amelyek az események fogadásához megadott kezelőre, valamint az indítási pozícióra irányítják az események áramlását. Például: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }