@azure/event-hubs package

Osztályok

EventHubBufferedProducerClient	A EventHubBufferedProducerClienthasználatával eseményeket tehet közzé egy adott eseményközpontban. A EventHubBufferedProducerClient nem teszi közzé azonnal az eseményeket. Ehelyett a rendszer puffereli az eseményeket, hogy hatékonyan kötegelhessék és közzétehessék őket, ha a köteg megtelt, vagy ha a maxWaitTimeInMs köteg eltelt, és nincsenek új események. Az események lekérésekor megadott beállításoktól függően előfordulhat, hogy automatikusan hozzá lesznek rendelve egy partícióhoz, a megadott partíciókulcs szerint csoportosítva, vagy hozzárendelhetők egy kifejezetten kért partícióhoz. Ez a modell arra szolgál, hogy a kötegkezelés terheit a hívóktól a nem determinisztikus időzítés árán elmozdítsa az események közzétételének időpontjára. 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 megelőzése érdekében a hívókat arra ösztönzik, hogy a és onSendEventsErrorHandler a kezelők használatával kövessék nyomon a onSendEventsSuccessHandler közzétételi folyamatot. A partíciókulcsot meghatározó események más partíciót rendelhetnek hozzá, 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ás több időt vehet igénybe, mint a többi gyártó. Olyan esetekben, amikor 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 ahol a rendelkezésre állás maximalizálása követelmény, az EventHubProducerClient ajánlott az használatával.
EventHubConsumerClient	Az 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 karakterlánc. Használja a kapcsolati karakterlánc 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.neta , és egy hitelesítőadat-objektumot. Igény szerint 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 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 ellenőrzőpont-tárolót is használja az alkalmazás több példányának terheléselosztására.
EventHubProducerClient	Az EventHubProducerClient osztály eseményközpontba küldi az eseményeket. Többféleképpen is létrehozható EventHubProducerClient Használja az Event Hub-példányhoz létrehozott SAS-szabályzat kapcsolati karakterlánc. Használja a kapcsolati karakterlánc 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.neta , é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 üzenetküldési hiba alaposztályát ismerteti.

Interfészek

BufferedCloseOptions	A metódus konfigurálásának close beállításai a EventHubBufferedProducerClientkövetkezőn: .
BufferedFlushOptions	A metódus konfigurálásának flush beállításai a EventHubBufferedProducerClientkövetkezőn: .
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 adott. Ha a felhasználó meghívja az updateCheckpoint()PartitionProcessor osztály metódusát, a rendszer belsőleg hoz létre egy metódust Checkpoint . Ezt követően a rendszer a felhasználó által CheckpointManager a létrehozásakor EventProcessorkiválasztott tárolási megoldásban tárolja. A felhasználóktól soha nem várható, hogy közvetlenül kommunikáljanak.Checkpoint Ez a felület a és CheckpointManagera belső működését támogatjaEventProcessor.
CheckpointStore	A checkpoint-tárolók egy eseményközpont-példány adott fogyasztói csoportjában található partíciók tulajdonjogi adatait és ellenőrzőpont-adatait tárolják és kérik le. A felhasználóknak nem kell implementálniuk a következőt CheckpointStore: . A felhasználók várhatóan kiválasztják a felület meglévő implementációit, példányosítják, majd átadják az EventHubConsumerClient osztálykonstruktornak az ügyfél példányosításakor. 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. Az implementációk CheckpointStore az npm-en találhatók, ha a @azure/eventhub-checkpointstore előtaggal rendelkező csomagokat keresnek.
CreateBatchOptions	A metódus konfigurálásának createBatch beállításai a EventHubProducerClientkövetkezőn: . 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 metódus konfigurálásának enqueueEvents beállításai a EventHubBufferedProcuerClientkövetkezőn: .
EventData	Az Event Hubnak küldendő adatokat leíró felület. Használja ezt hivatkozásként az elküldendő objektum létrehozásakor a EventHubProducerClienthasználatával. Példa: { body: "your-data" } vagy { body: "your-data", properties: { propertyName: "property value" } }
EventDataAdapterParameters	createEventDataAdapter Az eseményadat-adaptert létrehozó függvény paraméterei.
EventDataBatch	Egy esemény kötegét képviselő felület, amellyel eseményeket küldhet az Event Hubnak. A köteg létrehozásához használja a metódust createBatch() a EventHubProducerClientkövetkezőn: . 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 magát a tryAdd() köteg metódusát.
EventHubBufferedProducerClientOptions	Azokat a beállításokat ismerteti, amelyek a létrehozásakor megadhatóak EventHubBufferedProducerClient.
EventHubClientOptions	Az EventHubClient létrehozásakor megadható beállítások ismertetése. userAgent : A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc. 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 újrapróbálkozási lehetőségek az ügyfél/gyártó/fogyasztó összes műveletéhez. maxRetries : Újrapróbálkozási hiba esetén a művelet újrapróbálkozásának száma. maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások végrehajtásakor alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni az RetryMode enumerálás által megadott módon. A beállítások a és Fixeda.Exponential Alapértelmezés szerint a értékre van kapcsolva Fixed. retryDelayInMs: Ennyi időt kell várni ezredmásodpercben a következő kísérlet végrehajtása előtt. Ha mode a értékre Exponentialvan állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késlelteté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 lehet { "maxRetries": 4 }. Példahasználat: { retryOptions: { maxRetries: 4 } }
EventHubConnectionStringProperties	Az Event Hub kapcsolati karakterlánc részét képező tulajdonságok halmaza.
EventHubConsumerClientOptions	Az EventHubConsumerClient létrehozásakor megadható beállítások ismertetése. loadBalancingOptions: Az EventHubConsumerClient jogcímpartíciók hangolásának beállításai. userAgent : A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc. 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 újrapróbálkozási lehetőségek az ügyfél/gyártó/fogyasztó összes műveletéhez. maxRetries : Újrapróbálkozási hiba esetén a művelet újrapróbálkozásának száma. maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások végrehajtásakor alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni az RetryMode enumerálás által megadott módon. A beállítások a és Fixeda.Exponential Alapértelmezés szerint a értékre van kapcsolva Fixed. retryDelayInMs: Ennyi időt kell várni ezredmásodpercben a következő kísérlet végrehajtása előtt. Ha mode a értékre Exponentialvan állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késlelteté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 lehet { "maxRetries": 4 }. Példahasználat: { retryOptions: { maxRetries: 4 } }
EventHubProperties	Egy eseményközpont futásidejű adatait ismerteti.
EventPosition	Egy esemény pozícióját jelöli egy Eseményközpont-partíción, amely általában akkor használatos, amikor a subscribe() metódust egy-ra EventHubConsumerClient hívja, hogy meghatározza a partíció pozícióját az események fogadásának megkezdéséhez. Ha a stream kezdetét vagy végét jelölő EventPosition-t szeretne lekérni, használja az állandókat earliestEventPosition , illetve latestEventPosition azokat.
GetEventHubPropertiesOptions	A viselkedésének konfigurálására vonatkozó beállítások készlete getEventHubProperties. abortSignal : Az interfész implementációja, AbortSignalLike amely jelzi a művelet megszakítására irányuló kérést. parentSpan : A Span vagy SpanContext , amelyet a parent művelet meghívásakor létrehozott spanként szeretne használni.
GetPartitionIdsOptions	A viselkedésének konfigurálására vonatkozó beállítások készlete getPartitionIds. abortSignal : Az interfész implementációja, AbortSignalLike amely jelzi a művelet megszakítására irányuló kérést. parentSpan : A Span vagy SpanContext , amelyet a parent művelet meghívásakor létrehozott spanként szeretne használni.
GetPartitionPropertiesOptions	A viselkedésének konfigurálására vonatkozó beállítások készlete getPartitionProperties. abortSignal : Az interfész implementációja, AbortSignalLike amely jelzi a művelet megszakítására irányuló kérést. parentSpan : A Span vagy SpanContext , amelyet a parent művelet meghívásakor létrehozott spanként szeretne használni.
LastEnqueuedEventProperties	Egy 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 eseményközpontba, azt a partíciót, amelyhez hozzá lettek rendelve, valamint 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	Interfész, amely leírja az egyes függvények számára átadott környezetet, amelyek a SubscriptionEventHandlersrészét képezik. Ezen függvények bármelyikének implementálásakor a környezeti objektummal lekérheti a partícióval kapcsolatos információkat, valamint ellenőrizheti az ellenőrzőpontokat.
PartitionOwnership	Egy felület, amely azt jelzi, hogy egy EventProcessor adott partíció melyik példánya dolgoz fel egy adott partíciót egy Event Hub-példány fogyasztói csoportjából. Megjegyzés: Ezt belsőleg használja a felhasználó, és a EventProcessor felhasználónak soha nem kell közvetlenül létrehoznia.
PartitionProperties	Egy EventHub-partíció futásidejű adatait ismerteti.
ReceivedEventData	Az Eseményközponttól kapott esemény struktúráját leíró felület. Használja ezt referenciaként a függvény létrehozásakor az processEvents eseményközpontból fogadott események feldolgozásához a EventHubConsumerClienthasználatával.
RetryOptions	Újrapróbálkozási szabályzatbeállítások, amelyek meghatározzák a módot, az újrapróbálkozások számát, az újrapróbálkozási időközt stb.
SendBatchOptions	A metódus konfigurálásának sendBatch beállításai az EventHubProducerClient eseménytömb küldésekor. Ha partitionId be van állítva, nem szabad beállítani, partitionKey é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ához használt jel.
SubscribeOptions	A metódus konfigurálásának subscribe beállításai a EventHubConsumerClientkövetkezőn: . Például: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Subscription	A metódus által subscribe() visszaadott objektumot leíró felület a EventHubConsumerClientkövetkezőn: .
SubscriptionEventHandlers	A felhasználó által implementálandó függvényeket leíró felület, amelyet a EventHubConsumerClientsubscribe() metódus meghívásakor az eseményközpont eseményeinek fogadásához hív meg.
TokenCredential	Hitelesítési jogkivonat megadására alkalmas hitelesítő adatot jelöl.
TryAddOptions	A metódus viselkedésének tryAdd konfigurálására vonatkozó beállítások a 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ípusaliasok

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

Enumerációk

CloseReason	Az eseményközpont fogyasztói csoportjában lévő partíciók eseményeinek feldolgozásának leállításának különböző okait EventHubConsumerClient ábrázoló enumerálás.
RetryMode	Az újrapróbálkozási mód típusát ismerteti

Függvények

createEventDataAdapter(EventDataAdapterParameters)	Eseményadat-adaptert összeállító függvény. Ez az adapter @azure/schema-registry-avro használható az eseményadatok törzsének kódolására és dekódolására.
parseEventHubConnectionString(string)	A megadott kapcsolati karakterlánc a Azure Event Hubs alkalmazható különböző tulajdonságainak elemzése. A tulajdonságok akkor hasznosak, ha létrehoznak egy EventHubProducerClient vagy egy EventHubConsumerClient objektumot.

Függvény adatai

createEventDataAdapter(EventDataAdapterParameters)

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

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

Paraméterek

params

EventDataAdapterParameters

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

Válaszok

MessageAdapter<EventData>

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

parseEventHubConnectionString(string)

A megadott kapcsolati karakterlánc a Azure Event Hubs alkalmazható különböző tulajdonságainak elemzése. A tulajdonságok akkor hasznosak, ha létrehoznak egy EventHubProducerClient vagy egy EventHubConsumerClient objektumot.

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 karakterlánc.

Válaszok

Readonly<EventHubConnectionStringProperties>