@azure/event-hubs package
Klassen
EventHubBufferedProducerClient |
De De Afhankelijk van de opties die zijn opgegeven wanneer gebeurtenissen worden ge-enqueued, kunnen ze automatisch worden toegewezen aan een partitie, gegroepeerd op basis van de opgegeven partitiesleutel of een specifiek aangevraagde partitie worden toegewezen. Dit model is bedoeld om de belasting van batchbeheer te verschuiven van bellers, ten koste van niet-deterministische timing, voor wanneer gebeurtenissen worden gepubliceerd. Er zijn ook extra compromissen om rekening mee te houden:
In scenario's waarin het belangrijk is om gebeurtenissen onmiddellijk te publiceren met een deterministisch resultaat, moet u ervoor zorgen dat partitiesleutels worden toegewezen aan een partitie die consistent is met andere uitgevers, of wanneer het maximaliseren van de beschikbaarheid een vereiste is, wordt het gebruik van de |
EventHubConsumerClient |
De Er zijn meerdere manieren om een
U kunt eventueel ook het volgende doorgeven:
|
EventHubProducerClient |
De Er zijn meerdere manieren om een
U kunt desgewenst ook een optieverzameling doorgeven om het beleid voor opnieuw proberen of proxy-instellingen te configureren. |
MessagingError |
Beschrijft de basisklasse voor Berichtfout. |
Interfaces
BufferedCloseOptions |
Opties voor het configureren van de |
BufferedFlushOptions |
Opties voor het configureren van de |
Checkpoint |
Een controlepunt is bedoeld om de laatst verwerkte gebeurtenis door de gebruiker van een bepaalde partitie van een consumentengroep in een Event Hub-exemplaar weer te geven. Wanneer de Van gebruikers wordt nooit verwacht dat ze rechtstreeks communiceren. |
CheckpointStore |
In een controlepuntarchief worden gegevens over het eigendom van partities en controlepuntgegevens opgeslagen en opgehaald voor elke partitie in een bepaalde consumentengroep van een Event Hub-exemplaar. Gebruikers zijn niet bedoeld om een Implementaties van |
CreateBatchOptions |
Opties voor het configureren van de
Gebruiksvoorbeeld:
|
EnqueueEventOptions |
Opties voor het configureren van de |
EventData |
De interface die de gegevens beschrijft die naar Event Hub moeten worden verzonden.
Gebruik dit als referentie bij het maken van het object dat moet worden verzonden wanneer u de
|
EventDataAdapterParameters |
Parameters voor de |
EventDataBatch |
Een interface die een batch gebeurtenissen vertegenwoordigt die kan worden gebruikt om gebeurtenissen naar Event Hub te verzenden. Als u de batch wilt maken, gebruikt u de |
EventHubBufferedProducerClientOptions |
Hierin worden de opties beschreven die kunnen worden opgegeven tijdens het maken van de |
EventHubClientOptions |
Hierin worden de opties beschreven die kunnen worden geboden tijdens het maken van de EventHubClient.
Een eenvoudig gebruik kan zijn Gebruiksvoorbeeld:
|
EventHubConnectionStringProperties |
De set eigenschappen waaruit een Event Hub-verbindingsreeks bestaat. |
EventHubConsumerClientOptions |
Hierin worden de opties beschreven die kunnen worden geboden tijdens het maken van de EventHubConsumerClient.
Een eenvoudig gebruik kan zijn Gebruiksvoorbeeld:
|
EventHubProperties |
Beschrijft de runtime-informatie van een Event Hub. |
EventPosition |
Vertegenwoordigt de positie van een gebeurtenis in een Event Hub-partitie, die doorgaans wordt gebruikt bij het aanroepen van de Als u een EventPosition wilt ophalen die het begin of einde van de stream vertegenwoordigt, gebruikt u respectievelijk de constanten |
GetEventHubPropertiesOptions |
De set opties voor het configureren van het gedrag van
|
GetPartitionIdsOptions |
De set opties voor het configureren van het gedrag van
|
GetPartitionPropertiesOptions |
De set opties voor het configureren van het gedrag van
|
LastEnqueuedEventProperties |
Een set informatie over de laatste enqueued-gebeurtenis van een partitie, zoals waargenomen door de consument als gebeurtenissen worden ontvangen van de Event Hubs-service |
LoadBalancingOptions |
Een optiesverzameling voor het configureren van instellingen voor taakverdeling. |
OnSendEventsErrorContext |
Bevat de gebeurtenissen die niet naar de Event Hub zijn verzonden, de partitie waaraan ze zijn toegewezen en de fout die is opgetreden tijdens het verzenden. |
OnSendEventsSuccessContext |
Bevat de gebeurtenissen die zijn verzonden naar de Event Hub en de partitie waaraan ze zijn toegewezen. |
OperationOptions |
Opties voor het configureren van tracering en de abortSignal. |
PartitionContext |
Interface die de context beschrijft die wordt doorgegeven aan elk van de functies die deel uitmaken van de |
PartitionOwnership |
Een interface die de details weergeeft over welk exemplaar van een
Opmerking: dit wordt intern gebruikt door de |
PartitionProperties |
Beschrijft de runtime-informatie van een EventHub-partitie. |
ReceivedEventData |
De interface die de structuur beschrijft van de gebeurtenis die is ontvangen van Event Hub.
Gebruik dit als referentie bij het maken van de |
RetryOptions |
Beleidsopties voor opnieuw proberen die de modus, het aantal nieuwe pogingen, het interval voor nieuwe pogingen, enzovoort bepalen. |
SendBatchOptions |
Opties voor het configureren van de
|
SubscribeOptions |
Opties voor het configureren van de |
Subscription |
Interface die het object beschrijft dat wordt geretourneerd door de |
SubscriptionEventHandlers |
Interface die de functies beschrijft die moeten worden geïmplementeerd door de gebruiker die worden aangeroepen door de |
TokenCredential |
Vertegenwoordigt een referentie die een verificatietoken kan leveren. |
TryAddOptions |
Opties voor het configureren van het gedrag van de |
WebSocketImpl |
Beschrijft de vereiste vorm van WebSocket-constructors. |
WebSocketOptions |
Opties voor het configureren van de channeling van de AMQP-verbinding via websockets. |
Type-aliassen
ProcessCloseHandler |
Handtekening van de door de gebruiker opgegeven functie die wordt aangeroepen door |
ProcessErrorHandler |
Handtekening van de door de gebruiker opgegeven functie die wordt aangeroepen door |
ProcessEventsHandler |
Handtekening van de door de gebruiker opgegeven functie die wordt aangeroepen door |
ProcessInitializeHandler |
Handtekening van de door de gebruiker opgegeven functie die wordt aangeroepen door |
Enums
CloseReason |
Een opsomming die de verschillende redenen weergeeft voor een |
RetryMode |
Beschrijft het type Modus voor opnieuw proberen |
Functies
create |
Een functie die een gebeurtenisgegevensadapter maakt. Die adapter kan worden gebruikt met |
parse |
Parseert gegeven verbindingsreeks in de verschillende eigenschappen die van toepassing zijn op Azure Event Hubs. De eigenschappen zijn handig om vervolgens een EventHubProducerClient of een EventHubConsumerClient te maken. |
Functiedetails
createEventDataAdapter(EventDataAdapterParameters)
Een functie die een gebeurtenisgegevensadapter maakt. Die adapter kan worden gebruikt met @azure/schema-registry-avro
voor het coderen en decoderen van hoofdtekst in gebeurtenisgegevens.
function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>
Parameters
- params
- EventDataAdapterParameters
parameters voor het maken van de gebeurtenisgegevens
Retouren
MessageAdapter<EventData>
Een gebeurtenisgegevensadapter die gebeurtenisgegevens kan produceren en verbruiken
parseEventHubConnectionString(string)
Parseert gegeven verbindingsreeks in de verschillende eigenschappen die van toepassing zijn op Azure Event Hubs. De eigenschappen zijn handig om vervolgens een EventHubProducerClient of een EventHubConsumerClient te maken.
function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>
Parameters
- connectionString
-
string
De verbindingsreeks gekoppeld aan het beleid voor gedeelde toegang dat is gemaakt voor de Event Hubs-naamruimte.
Retouren
Readonly<EventHubConnectionStringProperties>