@azure/event-hubs package

Třídy

EventHubBufferedProducerClient	Slouží EventHubBufferedProducerClientk publikování událostí do konkrétního centra událostí. Nepublikuje EventHubBufferedProducerClient události okamžitě. Místo toho se události ukládají do vyrovnávací paměti, aby je bylo možné efektivně dávkově zabalit a publikovat, když je dávka plná nebo maxWaitTimeInMs uplynula bez nových událostí. V závislosti na možnostech zadaných při zařazení událostí do fronty mohou být automaticky přiřazeny k oddílu, seskupené podle zadaného klíče oddílu nebo přiřazené konkrétně požadovanému oddílu. Cílem tohoto modelu je přesunout zatížení správy dávek od volajících za cenu ne deterministického načasování, kdy budou události publikovány. Je potřeba zvážit i další kompromisy: Pokud dojde k chybovému ukončení aplikace, události ve vyrovnávací paměti nebudou publikovány. Aby se zabránilo ztrátě dat, doporučujeme volajícím sledovat průběh publikování pomocí onSendEventsSuccessHandler obslužných rutin a onSendEventsErrorHandler . Události určující klíč oddílu mohou mít přiřazený jiný oddíl než ty, které používají stejný klíč s jinými producenty. V nepravděpodobném případě, že se oddíl stane dočasně nedostupným, EventHubBufferedProducerClient může obnovení trvat déle než ostatní producenti. Ve scénářích, ve kterých je důležité, aby se události publikovaly okamžitě s deterministickým výsledkem, se ujistěte, že jsou klíče oddílů přiřazené k oddílu konzistentnímu s jinými vydavateli nebo kde je požadavkem maximalizace dostupnosti, použijte EventHubProducerClient příkaz .
EventHubConsumerClient	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ásad SAS vytvořených 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.
EventHubProducerClient	Třída se EventHubProducerClient používá k odesílání událostí do centra událostí. Existuje několik způsobů, jak vytvořit EventHubProducerClient Použijte připojovací řetězec ze zásad SAS vytvořených 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 tašku možností pro konfiguraci zásad opakování nebo nastavení proxy serveru.
MessagingError	Popisuje základní třídu pro zasílání zpráv Error.

Rozhraní

BufferedCloseOptions	Možnosti konfigurace metody na close .EventHubBufferedProducerClient
BufferedFlushOptions	Možnosti konfigurace metody na flush .EventHubBufferedProducerClient
Checkpoint	Kontrolní bod představuje poslední úspěšně zpracovanou událost uživatelem z konkrétního oddílu skupiny příjemců v instanci centra událostí. updateCheckpoint() Když je metoda ve PartitionProcessor třídě volána uživatelem, Checkpoint vytvoří se interně. Pak se uloží do řešení úložiště implementovaného uživatelem CheckpointManager při vytváření EventProcessor. Od uživatelů se nikdy neočekává přímá interakce Checkpoint . Toto rozhraní existuje pro podporu interních fungování a EventProcessorCheckpointManager.
CheckpointStore	Úložiště kontrolních bodů ukládá a načítá informace o vlastnictví oddílu a podrobnosti kontrolního bodu pro každý oddíl v dané skupině příjemců instance centra událostí. Uživatelé nejsou určeni k implementaci objektu CheckpointStore. Očekává se, že uživatelé zvolí existující implementace tohoto rozhraní, vytvoří jeho instanci a předají ho konstruktoru EventHubConsumerClient třídy při vytváření instance klienta. U uživatelů se neočekává použití žádné z metod v úložišti kontrolních bodů. Klient je používá interně. CheckpointStore Implementace najdete na npm vyhledáním balíčků s předponou @azure/eventhub-checkpointstore-.
CreateBatchOptions	Možnosti konfigurace metody na createBatch .EventHubProducerClient partitionKey : Hodnota, která má hodnotu hash za účelem vytvoření přiřazení oddílu. maxSizeInBytes: Horní limit pro velikost dávky. abortSignal : Signál požadavku na zrušení operace odeslání. Příklad použití: { partitionKey: 'foo', maxSizeInBytes: 1024 * 1024 // 1 MB }
EnqueueEventOptions	Možnosti konfigurace metody na enqueueEvents .EventHubBufferedProducerClient
EventData	Rozhraní, které popisuje data, která se mají odeslat do centra událostí. Použijte ho jako referenci při vytváření objektu, který se má odeslat při použití EventHubProducerClient. Příkladem je { body: "your-data" } nebo . { body: "your-data", properties: { propertyName: "property value" } }
EventDataAdapterParameters	createEventDataAdapter Parametry funkce, která vytváří adaptér dat událostí.
EventDataBatch	Rozhraní představující dávku událostí, kterou lze použít k odesílání událostí do centra událostí. K vytvoření dávky použijte metodu createBatch() na EventHubProducerClient. K odeslání dávky použijte metodu sendBatch() na stejném klientovi. K vyplnění dávky použijte metodu tryAdd() v samotné dávce.
EventHubBufferedProducerClientOptions	Popisuje možnosti, které lze poskytnout při vytváření EventHubBufferedProducerClient.
EventHubClientOptions	Popisuje možnosti, které lze poskytnout při vytváření EventHubClient. userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který se předá službě jako vlastnost připojení. webSocketOptions : Možnosti konfigurace channelingu připojení AMQP přes webové sokety. websocket : Konstruktor WebSocket použitý k vytvoření připojení AMQP, pokud se rozhodnete vytvořit připojení přes WebSocket. webSocketConstructorOptions : Možnosti předání do websocket konstruktoru, když se rozhodnete vytvořit připojení přes WebSocket. retryOptions : Možnosti opakování pro všechny operace na klientovi, producentovi nebo příjemci. maxRetries : Kolikrát je možné operaci zopakovat v případě opakovatelné chyby. maxRetryDelayInMs: Maximální zpoždění mezi opakovanými pokusy. Platí pouze při provádění exponenciálních opakování. mode: Který režim opakování se má použít, určený výčtem RetryMode . Možnosti jsou Exponential a Fixed. Výchozí hodnota je Fixed. retryDelayInMs: Doba čekání v milisekundách před provedením dalšího pokusu. Pokud mode je nastavená hodnota Exponential, použije se k výpočtu exponenciálně rostoucích zpoždění mezi opakovanými pokusy. Výchozí hodnota: 30000 milisekund. timeoutInMs: Doba čekání v milisekundách před vypršením časového limitu operace. Pokud zbývají nějaké pokusy o opakování, aktivuje se tím opakování. Výchozí hodnota: 60000 milisekund. Jednoduché použití může být { "maxRetries": 4 }. Příklad použití: { retryOptions: { maxRetries: 4 } }
EventHubConnectionStringProperties	Sada vlastností, které tvoří centrum událostí připojovací řetězec.
EventHubConsumerClientOptions	Popisuje možnosti, které lze poskytnout při vytváření EventHubConsumerClient. loadBalancingOptions: Možnosti ladění, jak oddíly deklarací identity EventHubConsumerClient userAgent : Řetězec, který se má připojit k integrovanému řetězci uživatelského agenta, který se předá službě jako vlastnost připojení. webSocketOptions : Možnosti konfigurace channelingu připojení AMQP přes webové sokety. websocket : Konstruktor WebSocket použitý k vytvoření připojení AMQP, pokud se rozhodnete vytvořit připojení přes WebSocket. webSocketConstructorOptions : Možnosti předání do websocket konstruktoru, když se rozhodnete vytvořit připojení přes WebSocket. retryOptions : Možnosti opakování pro všechny operace na klientovi, producentovi nebo příjemci. maxRetries : Kolikrát je možné operaci zopakovat v případě opakovatelné chyby. maxRetryDelayInMs: Maximální zpoždění mezi opakovanými pokusy. Platí pouze při provádění exponenciálních opakování. mode: Který režim opakování se má použít, určený výčtem RetryMode . Možnosti jsou Exponential a Fixed. Výchozí hodnota je Fixed. retryDelayInMs: Doba čekání v milisekundách před provedením dalšího pokusu. Pokud mode je nastavená hodnota Exponential, použije se k výpočtu exponenciálně rostoucích zpoždění mezi opakovanými pokusy. Výchozí hodnota: 30000 milisekund. timeoutInMs: Doba čekání v milisekundách před vypršením časového limitu operace. Pokud zbývají nějaké pokusy o opakování, aktivuje se tím opakování. Výchozí hodnota: 60000 milisekund. Jednoduché použití může být { "maxRetries": 4 }. Příklad použití: { retryOptions: { maxRetries: 4 } }
EventHubProperties	Popisuje informace o modulu runtime centra událostí.
EventPosition	Představuje pozici události v oddílu centra událostí, která se obvykle používá při volání subscribe() metody na objektu k EventHubConsumerClient určení pozice v oddílu, ze které má začít přijímat události. Pokud chcete získat EventPosition představující začátek nebo konec datového proudu, použijte konstanty earliestEventPosition a latestEventPosition v uvedeném pořadí.
GetEventHubPropertiesOptions	Sada možností pro konfiguraci chování nástroje getEventHubProperties. abortSignal : Implementace AbortSignalLike rozhraní pro signalizaci požadavku na zrušení operace. parentSpan : Hodnota Span nebo SpanContext , která se má použít jako parent z rozsahu vytvořeného při volání této operace.
GetPartitionIdsOptions	Sada možností pro konfiguraci chování nástroje getPartitionIds. abortSignal : Implementace AbortSignalLike rozhraní pro signalizaci požadavku na zrušení operace. parentSpan : Hodnota Span nebo SpanContext , která se má použít jako parent z rozsahu vytvořeného při volání této operace.
GetPartitionPropertiesOptions	Sada možností pro konfiguraci chování nástroje getPartitionProperties. abortSignal : Implementace AbortSignalLike rozhraní pro signalizaci požadavku na zrušení operace. parentSpan : Hodnota Span nebo SpanContext , která se má použít jako parent z rozsahu vytvořeného při volání této operace.
LastEnqueuedEventProperties	Sada informací o poslední události oddílu ve frontě, kterou příjemce pozoruje při přijetí událostí ze služby Event Hubs.
LoadBalancingOptions	Sada možností pro konfiguraci nastavení vyrovnávání zatížení.
OnSendEventsErrorContext	Obsahuje události, které nebyly úspěšně odeslány do centra událostí, oddíl, ke kterému byly přiřazeny, a chybu, ke které došlo při odesílání.
OnSendEventsSuccessContext	Obsahuje události, které byly úspěšně odeslány do centra událostí, a oddíl, ke kterému byly přiřazeny.
OperationOptions	Možnosti pro konfiguraci trasování a abortSignal.
PartitionContext	Rozhraní, které popisuje kontext předaný každé z funkcí, které jsou součástí SubscriptionEventHandlers. Při implementaci některé z těchto funkcí použijte kontextový objekt k získání informací o oddílu a možnosti kontrolního bodu.
PartitionOwnership	Rozhraní představující podrobnosti o tom, která instance EventProcessor vlastní zpracování daného oddílu ze skupiny příjemců instance centra událostí. Poznámka: Používá ho interně EventProcessor a uživatel ho nikdy nevytvoří přímo.
PartitionProperties	Popisuje informace o modulu runtime oddílu EventHub.
ReceivedEventData	Rozhraní, které popisuje strukturu události přijaté z centra událostí. Použijte ho jako referenci při vytváření processEvents funkce pro zpracování událostí přijatých z centra událostí při použití EventHubConsumerClient.
RetryOptions	Možnosti zásad opakování, které určují režim, počet opakování, interval opakování atd.
SendBatchOptions	Možnosti konfigurace metody pro sendBatch při EventHubProducerClient odesílání pole událostí. Pokud partitionId je nastavena hodnota , partitionKey nesmí být nastavena a naopak. partitionId : Oddíl, do který se tato dávka odešle. partitionKey : Hodnota, která má hodnotu hash vytvořit přiřazení oddílu. abortSignal : Signál používaný ke zrušení operace odeslání.
SubscribeOptions	Možnosti konfigurace metody v subscribeEventHubConsumerClient. Například { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }.
Subscription	Rozhraní, které popisuje objekt vrácený metodou subscribe() v objektu EventHubConsumerClient.
SubscriptionEventHandlers	Rozhraní, které popisuje funkce, které mají být implementovány uživatelem, které jsou vyvolány EventHubConsumerClient při subscribe() zavolání metody pro příjem událostí z centra událostí.
TokenCredential	Představuje přihlašovací údaje, které mohou poskytnout ověřovací token.
TryAddOptions	Možnosti konfigurace chování tryAdd metody ve EventDataBatch třídě
WebSocketImpl	Popisuje požadovaný tvar WebSocket konstruktory.
WebSocketOptions	Možnosti konfigurace channelingu připojení AMQP přes webové sokety.

Aliasy typu

ProcessCloseHandler	Podpis uživatelem poskytnuté funkce vyvolána EventHubConsumerClient hned po zastavení, aby přijímala události z oddílu.
ProcessErrorHandler	Signatura uživatelem poskytnuté funkce vyvolána v EventHubConsumerClient případě chyb, ke kterým dochází při přijímání událostí nebo při provádění funkcí poskytnutých uživatelem předaných subscribe() metodě.
ProcessEventsHandler	Signatura uživatelem poskytnuté funkce vyvolána EventHubConsumerClient při přijetí sady událostí.
ProcessInitializeHandler	Signatura uživatelem poskytnuté funkce vyvolána EventHubConsumerClient těsně před tím, než začne přijímat události z oddílu.

Výčty

CloseReason	Výčet představující různé důvody zastavení EventHubConsumerClient zpracování událostí z oddílu ve skupině příjemců centra událostí.
RetryMode	Popisuje typ Režimu opakování.

Funkce

createEventDataAdapter(EventDataAdapterParameters)	Funkce, která sestaví adaptér dat událostí. Tento adaptér se dá použít ke @azure/schema-registry-avro kódování a dekódování těla v datech událostí.
parseEventHubConnectionString(string)	Analyzuje zadané připojovací řetězec do různých vlastností použitelných pro Azure Event Hubs. Vlastnosti jsou užitečné k vytvoření EventHubProducerClient nebo EventHubConsumerClient.

Podrobnosti funkce

createEventDataAdapter(EventDataAdapterParameters)

Funkce, která sestaví adaptér dat událostí. Tento adaptér se dá použít ke @azure/schema-registry-avro kódování a dekódování těla v datech událostí.

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

Parametry

params

EventDataAdapterParameters

parametry pro vytvoření dat událostí

Návraty

MessageAdapter<EventData>

Datový adaptér událostí, který může vytvářet a využívat data událostí

parseEventHubConnectionString(string)

Analyzuje zadané připojovací řetězec do různých vlastností použitelných pro Azure Event Hubs. Vlastnosti jsou užitečné k vytvoření EventHubProducerClient nebo EventHubConsumerClient.

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

Parametry

connectionString

string

Připojovací řetězec přidružené k zásadám sdíleného přístupu vytvořené pro obor názvů služby Event Hubs.

Návraty

Readonly<EventHubConnectionStringProperties>