@azure/event-hubs package

Előkelő társaság

EventHubBufferedProducerClient	A EventHubBufferedProducerClientegy adott eseményközpontban való események közzétételére szolgál. A EventHubBufferedProducerClient nem teszi közzé azonnal az eseményeket. Ehelyett az események pufferelve vannak, hogy hatékonyan kötegelhetők és közzétehetők, ha a köteg megtelt, vagy ha a maxWaitTimeInMs új események lekérése nélkül eltelt. Az események lekérésekor megadott beállításoktól függően automatikusan hozzárendelhetők egy partícióhoz, csoportosíthatók a megadott partíciókulcs szerint, vagy hozzárendelhetők egy kifejezetten kért partícióhoz. A modell célja, hogy a kötegkezelés terheit a hívóktól a nem determinisztikus időzítés árán, az események közzétételének időpontjára irányozza át. További kompromisszumokat is figyelembe kell venni: Ha az alkalmazás összeomlik, a pufferben lévő események nem lesznek közzétéve. Az adatvesztés megakadályozása érdekében a hívóknak ajánlott nyomon követni a közzététel előrehaladását a onSendEventsSuccessHandler és onSendEventsErrorHandler kezelőkkel. A partíciókulcsot meghatározó események más partícióhoz rendelhetők, mint azok, amelyek ugyanazt a kulcsot használják más gyártókkal. Abban a valószínűtlen esetben, ha egy partíció átmenetileg elérhetetlenné válik, a EventHubBufferedProducerClient helyreállítása hosszabb időt vehet igénybe, mint a többi gyártó. Olyan helyzetekben, ahol fontos, hogy az események azonnal, determinisztikus eredménnyel legyenek közzétéve, győződjön meg arról, hogy a partíciókulcsok más közzétevőkkel konzisztens partícióhoz vannak rendelve, vagy ha a rendelkezésre állás maximalizálása követelmény, a EventHubProducerClient használata ajánlott.
EventHubConsumerClient	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ét. Használja a kapcsolati sztringet az Event Hub-névtérhez létrehozott SAS-szabályzatból és az Event Hub-példány nevéből Használja a teljes névteret, például <yournamespace>.servicebus.windows.net, és egy hitelesítőadat-objektumot. Opcionálisan a következőket is átadhatja: Az újrapróbálkozás szabályzatának vagy proxybeállításainak konfigurálására szolgáló beállításcsomag. Egy ellenőrzőpont-tároló, amelyet az ügyfél használ az ellenőrzőpontok olvasásához annak meghatározásához, hogy az alkalmazás újraindításakor honnan kell folytatnia az események fogadását. 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ához.
EventHubProducerClient	A EventHubProducerClient osztály eseményeket küld egy Eseményközpontba. Többféleképpen is létrehozhat EventHubProducerClient Használja az Event Hub-példányhoz létrehozott SAS-szabályzat kapcsolati sztringét. Használja a kapcsolati sztringet az Event Hub-névtérhez létrehozott SAS-szabályzatból és az Event Hub-példány nevéből Használja a teljes névteret, például <yournamespace>.servicebus.windows.net, és egy hitelesítőadat-objektumot. Az újrapróbálkozás szabályzatának vagy proxybeállításainak konfigurálásához megadhat egy beállításcsomagot is.
MessagingError	Az üzenetkezelési hiba alaposztályát ismerteti.

Felületek

BufferedCloseOptions	A closeEventHubBufferedProducerClient metódusának konfigurálására vonatkozó beállítások.
BufferedFlushOptions	A flushEventHubBufferedProducerClient metódusának konfigurálására vonatkozó beállítások.
Checkpoint	Az ellenőrzőpont azt az utolsó sikeresen feldolgozott eseményt jelöli, amelyet a felhasználó az Event Hub-példány egy fogyasztói csoportjának egy adott partíciójáról készített. Ha a felhasználó meghívja az updateCheckpoint() osztály PartitionProcessor metódusát, belső Checkpoint jön létre. Ezt követően a rendszer a CheckpointManagerlétrehozásakor a felhasználó által kiválasztott EventProcessor által implementált tárolási megoldásban tárolja. A felhasználóknak soha nem kell közvetlenül Checkpoint használniuk. Ez a felület támogatja EventProcessor és CheckpointManagerbelső működését.
CheckpointStore	Az ellenőrzőpont-tároló tárolja és lekéri a partíció tulajdonjogi adatait és ellenőrzőpont-adatait az eseményközpont-példány adott fogyasztói csoportjában lévő egyes partíciókhoz. A felhasználók nem kívánnak CheckpointStoreimplementálni. Az ügyfél példányosításakor a felhasználóknak ki kell választaniuk a felület meglévő implementációit, példányosítaniuk kell, majd át kell adniuk az EventHubConsumerClient osztálykonstruktornak. A felhasználóknak nem kell használniuk az ellenőrzőpont-tárolók egyik metódusát sem, ezeket az ügyfél belsőleg használja. A CheckpointStore implementációi az npm-en találhatók a @azure/eventhub-checkpointstore előtaggal rendelkező csomagok keresésével.
CreateBatchOptions	A createBatchEventHubProducerClient metódusának konfigurálására vonatkozó beállítások. partitionKey: A partíció-hozzárendelés létrehozásához kivonatolt érték. maxSizeInBytes: A köteg méretének felső korlátja. abortSignal: A küldési művelet megszakítására irányuló kérés jelzése. Példahasználat: { partitionKey: 'foo', maxSizeInBytes: 1024 * 1024 // 1 MB }
EnqueueEventOptions	A enqueueEventsEventHubBufferedProducerClient metódusának konfigurálására vonatkozó beállítások.
EventData	Az Event Hubnak küldendő adatokat leíró felület. Használja ezt hivatkozásként a EventHubProducerClienthasználatakor küldendő objektum létrehozásakor. Például { body: "your-data" } vagy { body: "your-data", properties: { propertyName: "property value" } }
EventDataAdapterParameters	Az eseményadat-adaptert létrehozó createEventDataAdapter függvény paraméterei.
EventDataBatch	Egy eseményköteget képviselő felület, amely az események Event Hubba való küldéséhez használható. A köteg létrehozásához használja a createBatch()EventHubProducerClient metódusát. A köteg elküldéséhez használja a sendBatch() metódust ugyanazon az ügyfélen. A köteg kitöltéséhez használja a tryAdd() metódust a kötegen.
EventHubBufferedProducerClientOptions	A EventHubBufferedProducerClientlétrehozásakor megadható beállításokat ismerteti.
EventHubClientOptions	Az EventHubClient létrehozása során megadható beállításokat ismerteti. userAgent: A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring. webSocketOptions: Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai. websocket: Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. webSocketConstructorOptions: A Websocket-konstruktornak átadandó beállítások, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. retryOptions: Az ügyfél/gyártó/fogyasztó összes műveletének újrapróbálkozási lehetőségei. maxRetries: A művelet újrapróbálkozásának száma újrapróbálkozási hiba esetén. maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások esetén alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni a RetryMode enumerálás által megadott módon. A beállítások Exponential és Fixed. Alapértelmezés szerint Fixed. retryDelayInMs: A következő kísérlet végrehajtása előtt ezredmásodpercben várni kell. Ha modeExponentialértékre van állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késés kiszámítására szolgál. Alapértelmezett: 30000 ezredmásodperc. timeoutInMs: Ennyi idő ezredmásodpercben, amíg a művelet túllépi az időkorlátot. Ez újrapróbálkozási műveletet indít el, ha még vannak újrapróbálkozási kísérletek. Alapértelmezett érték: 60000 ezredmásodperc. Az egyszerű használat { "maxRetries": 4 }lehet. Példahasználat: { retryOptions: { maxRetries: 4 } }
EventHubConnectionStringProperties	Az Event Hub kapcsolati sztringet alkotó tulajdonságok készlete.
EventHubConsumerClientOptions	Az EventHubConsumerClient létrehozásakor megadható beállításokat ismerteti. loadBalancingOptions: Az EventHubConsumerClient jogcímpartícióinak finomhangolása. userAgent: A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring. webSocketOptions: Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai. websocket: Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. webSocketConstructorOptions: A Websocket-konstruktornak átadandó beállítások, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. retryOptions: Az ügyfél/gyártó/fogyasztó összes műveletének újrapróbálkozási lehetőségei. maxRetries: A művelet újrapróbálkozásának száma újrapróbálkozási hiba esetén. maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások esetén alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni a RetryMode enumerálás által megadott módon. A beállítások Exponential és Fixed. Alapértelmezés szerint Fixed. retryDelayInMs: A következő kísérlet végrehajtása előtt ezredmásodpercben várni kell. Ha modeExponentialértékre van állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késés kiszámítására szolgál. Alapértelmezett: 30000 ezredmásodperc. timeoutInMs: Ennyi idő ezredmásodpercben, amíg a művelet túllépi az időkorlátot. Ez újrapróbálkozási műveletet indít el, ha még vannak újrapróbálkozási kísérletek. Alapértelmezett érték: 60000 ezredmásodperc. Az egyszerű használat { "maxRetries": 4 }lehet. Példahasználat: { retryOptions: { maxRetries: 4 } }
EventHubProperties	Az eseményközpont futásidejű adatait ismerteti.
EventPosition	Egy esemény pozícióját jelöli egy Event Hub-partícióban, amely általában a subscribe() metódus meghívásakor használatos egy EventHubConsumerClient a partícióban az események fogadásának megkezdéséhez. A stream kezdetét vagy végét jelképező EventPosition lekéréséhez használja a earliestEventPosition és a latestEventPosition állandókat.
GetEventHubPropertiesOptions	A getEventHubPropertiesviselkedésének konfigurálására vonatkozó beállítások készlete. abortSignal: A AbortSignalLike felület implementálása, amely jelzi a művelet megszakítására irányuló kérést. parentSpan: A művelet meghívásakor létrehozott span SpanSpanContext vagy parent.
GetPartitionIdsOptions	A getPartitionIdsviselkedésének konfigurálására vonatkozó beállítások készlete. abortSignal: A AbortSignalLike felület implementálása, amely jelzi a művelet megszakítására irányuló kérést. parentSpan: A művelet meghívásakor létrehozott span SpanSpanContext vagy parent.
GetPartitionPropertiesOptions	A getPartitionPropertiesviselkedésének konfigurálására vonatkozó beállítások készlete. abortSignal: A AbortSignalLike felület implementálása, amely jelzi a művelet megszakítására irányuló kérést. parentSpan: A művelet meghívásakor létrehozott span SpanSpanContext vagy parent.
LastEnqueuedEventProperties	A partíció utolsó lekérdezett eseményére vonatkozó információkészlet, amelyet a fogyasztó megfigyelt, amikor az események az Event Hubs szolgáltatástól érkeznek
LoadBalancingOptions	Egy beállításcsomag a terheléselosztási beállítások konfigurálásához.
OnSendEventsErrorContext	Tartalmazza azokat az eseményeket, amelyeket nem sikerült elküldeni az Event Hubnak, a hozzájuk rendelt partíciót és a küldés során észlelt hibát.
OnSendEventsSuccessContext	Az eseményközpontba sikeresen elküldött eseményeket és a hozzájuk rendelt partíciót tartalmazza.
OperationOptions	A nyomkövetés és az abortSignal konfigurálásának lehetőségei.
PartitionContext	A SubscriptionEventHandlersrészét képező egyes függvények számára átadott környezetet leíró felület. Ezen függvények bármelyikének implementálásakor a környezeti objektum használatával szerezze be a partícióval kapcsolatos információkat, valamint az ellenőrzőpont-ellenőrzést.
PartitionOwnership	Egy EventProcessor egy adott partíciónak az Event Hub-példány egy fogyasztói csoportjából történő feldolgozását bemutató felület. Megjegyzés: Ezt a EventProcessor belsőleg használja, és a felhasználónak soha nem kell közvetlenül létrehoznia.
PartitionProperties	Egy EventHub-partíció futásidejű adatait ismerteti.
ReceivedEventData	Az Event Hubtól kapott esemény struktúráját leíró felület. Használja ezt hivatkozásként a processEvents függvény létrehozásakor az eseményközpontból érkező események feldolgozásához a EventHubConsumerClienthasználatakor.
RetryOptions	Próbálkozzon újra a házirend beállításaival, amelyek meghatározzák a módot, az újrapróbálkozási lehetőségek számát, az újrapróbálkozási időközt stb.
SendBatchOptions	A sendBatch metódus konfigurálásának beállításai az EventHubProducerClient eseménytömb küldésekor. Ha partitionId van beállítva, partitionKey nem szabad beállítani, és fordítva. partitionId: A köteg partíciója lesz elküldve. partitionKey: A partíció-hozzárendelés létrehozásához kivonatolt érték. abortSignal: A küldési művelet megszakítására szolgáló jel.
SubscribeOptions	A subscribeEventHubConsumerClient metódusának konfigurálására vonatkozó beállítások. Például { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Subscription	A subscribe()EventHubConsumerClient metódus által visszaadott objektumot leíró felület.
SubscriptionEventHandlers	A felhasználó által implementálandó függvényeket leíró felület, amelyet a EventHubConsumerClient hív meg, amikor a subscribe() metódus meghívja az események fogadására az Event Hubtól.
TokenCredential	Hitelesítési jogkivonat megadására alkalmas hitelesítő adatokat jelöl.
TryAddOptions	A tryAdd metódus viselkedésének konfigurálásának beállításai az EventDataBatch osztályban.
WebSocketImpl	A WebSocket konstruktorok szükséges alakját ismerteti.
WebSocketOptions	Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.

Típus-aliasok

ProcessCloseHandler	A felhasználó által megadott függvény aláírása, amelyet a EventHubConsumerClient hív meg, miután leállt, hogy eseményeket fogadjon egy partícióról.
ProcessErrorHandler	A felhasználó által megadott függvény aláírása, amelyet a EventHubConsumerClient az események fogadásakor vagy a felhasználó által a subscribe() metódusnak átadott függvények végrehajtásakor előforduló hibák esetén hív meg.
ProcessEventsHandler	A felhasználó által megadott függvény aláírása, amelyet a EventHubConsumerClient hív meg események fogadásakor.
ProcessInitializeHandler	A felhasználó által megadott függvény aláírása, amelyet EventHubConsumerClient hív meg, mielőtt eseményeket fogad egy partícióról.

Enums

CloseReason	Egy EventHubConsumerClient különböző okait megjelenítő szám, amely az eseményközpontok fogyasztói csoportjában lévő partíciókból származó események feldolgozását állítja le.
RetryMode	Az újrapróbálkozási mód típusát ismerteti

Functions

createEventDataAdapter(EventDataAdapterParameters)	Eseményadat-adaptert összeállító függvény. Ez az adapter használható @azure/schema-registry-avro az eseményadatok törzsének kódolásához és dekódolásához.
parseEventHubConnectionString(string)	A megadott kapcsolati sztringet az Azure Event Hubsra vonatkozó különböző tulajdonságokba elemzi. A tulajdonságok hasznosak egy EventHubProducerClient vagy egy EventHubConsumerClient létrehozásához.

Változók

earliestEventPosition	Megkapja az EventPosition első esemény helyét a partícióban. Ezt a pozíciót adjuk át annak a EventHubConsumerClient.subscribe() metódusnak, amely elkezdi az eseményeket az első eseménytől a partícióban, amely a megtartási politika miatt nem járt le.
latestEventPosition	Megkapja a EventPosition partíció végének megfelelőjét. Add át ezt a pozíciót a EventHubConsumerClient.subscribe() metódusnak, hogy elkezdje az események fogadását közvetlenül a metódushívás után sorba állított eseményből.
logger	A @azure/logger csomag konfigurációja. Ez a névtér előtagjával fog naplókat azure:event-hubs adni.

Funkciók részletei

createEventDataAdapter(EventDataAdapterParameters)

Eseményadat-adaptert összeállító függvény. Ez az adapter használható @azure/schema-registry-avro az eseményadatok törzsének kódolásához és dekódolásához.

function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>

Paraméterek

params

EventDataAdapterParameters

paraméterek az eseményadatok létrehozásához

Visszatér

MessageAdapter<EventData>

Eseményadat-adapter, amely képes eseményadatok előállítására és felhasználására

parseEventHubConnectionString(string)

A megadott kapcsolati sztringet az Azure Event Hubsra vonatkozó különböző tulajdonságokba elemzi. A tulajdonságok hasznosak egy EventHubProducerClient vagy egy EventHubConsumerClient létrehozásához.

function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>

Paraméterek

connectionString

string

Az Event Hubs-névtérhez létrehozott megosztott hozzáférési szabályzathoz társított kapcsolati sztring.

Visszatér

Readonly<EventHubConnectionStringProperties>

Variable Details

earliestEventPosition

Megkapja az EventPosition első esemény helyét a partícióban. Ezt a pozíciót adjuk át annak a EventHubConsumerClient.subscribe() metódusnak, amely elkezdi az eseményeket az első eseménytől a partícióban, amely a megtartási politika miatt nem járt le.

earliestEventPosition: EventPosition

Típus

EventPosition

latestEventPosition

Megkapja a EventPosition partíció végének megfelelőjét. Add át ezt a pozíciót a EventHubConsumerClient.subscribe() metódusnak, hogy elkezdje az események fogadását közvetlenül a metódushívás után sorba állított eseményből.

latestEventPosition: EventPosition

Típus

EventPosition

logger

A @azure/logger csomag konfigurációja. Ez a névtér előtagjával fog naplókat azure:event-hubs adni.

logger: AzureLogger

Típus

AzureLogger