EventHubConsumerClient class
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Istnieje wiele sposobów tworzenia EventHubConsumerClient
- Użyj parametrów połączenia z zasad sygnatury dostępu współdzielonego utworzonych dla wystąpienia centrum zdarzeń.
- Użyj parametrów połączenia z zasad sygnatury dostępu współdzielonego utworzonych dla przestrzeni nazw centrum zdarzeń oraz nazwy wystąpienia centrum zdarzeń
- Użyj pełnej przestrzeni nazw, takiej jak
<yournamespace>.servicebus.windows.net, i obiektu poświadczeń.
Opcjonalnie możesz również przekazać następujące elementy:
- Pakiet opcji umożliwiający skonfigurowanie zasad ponawiania prób lub ustawień serwera proxy.
- Magazyn punktów kontrolnych używany przez klienta do odczytywania punktów kontrolnych w celu określenia położenia, z którego powinien wznowić odbieranie zdarzeń po ponownym uruchomieniu aplikacji. Magazyn punktów kontrolnych jest również używany przez klienta do równoważenia obciążenia wielu wystąpień aplikacji.
Konstruktory
| Event |
Klasa |
| Event |
Klasa |
| Event |
Klasa |
| Event |
Klasa |
| Event |
Klasa |
| Event |
Klasa |
Właściwości
| default |
Nazwa domyślnej grupy odbiorców w usłudze Event Hubs. |
| event |
Nazwa wystąpienia centrum zdarzeń, dla którego jest tworzony ten klient. |
| fully |
W pełni kwalifikowana przestrzeń nazw wystąpienia centrum zdarzeń, dla którego jest tworzony ten klient. Prawdopodobnie będzie to podobne do .servicebus.windows.net. |
| identifier | Nazwa używana do identyfikowania tego elementu EventHubConsumerClient. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy. |
Metody
| close() | Zamyka połączenie AMQP z wystąpieniem centrum zdarzeń, zwracając obietnicę, która zostanie rozwiązana po zakończeniu rozłączenia. |
| get |
Udostępnia informacje o środowisku uruchomieniowym centrum zdarzeń. |
| get |
Zawiera identyfikator każdej partycji skojarzonej z centrum zdarzeń. |
| get |
Zawiera informacje o stanie określonej partycji. |
| subscribe(string, Subscription |
Subskrybowanie zdarzeń z jednej partycji. Wywołaj metodę close() dla zwróconego obiektu, aby zatrzymać odbieranie zdarzeń. Przykład użycia: |
| subscribe(Subscription |
Subskrybowanie zdarzeń ze wszystkich partycji. Jeśli magazyn punktów kontrolnych jest dostarczany do Wywołaj metodę close() dla zwróconego obiektu, aby zatrzymać odbieranie zdarzeń. Przykład użycia: |
Szczegóły konstruktora
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- connectionString
-
string
Parametry połączenia używane do nawiązywania połączenia z wystąpieniem centrum zdarzeń. Oczekuje się, że właściwości klucza współużytkowanego i ścieżka centrum zdarzeń znajdują się w tych parametrach połączenia. np. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- checkpointStore
- CheckpointStore
Magazyn punktów kontrolnych używany przez klienta do odczytywania punktów kontrolnych w celu określenia położenia, z którego powinien wznowić odbieranie zdarzeń po ponownym uruchomieniu aplikacji. Jest on również używany przez klienta do równoważenia obciążenia wielu wystąpień aplikacji.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- connectionString
-
string
Parametry połączenia używane do nawiązywania połączenia z wystąpieniem centrum zdarzeń. Oczekuje się, że właściwości klucza współużytkowanego i ścieżka centrum zdarzeń znajdują się w tych parametrach połączenia. np. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- connectionString
-
string
Parametry połączenia używane do nawiązywania połączenia z przestrzenią nazw usługi Event Hubs. Oczekiwano, że właściwości klucza współużytkowanego znajdują się w tych parametrach połączenia, ale nie w ścieżce centrum zdarzeń, np. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Nazwa określonego centrum zdarzeń do połączenia klienta.
- checkpointStore
- CheckpointStore
Magazyn punktów kontrolnych używany przez klienta do odczytywania punktów kontrolnych w celu określenia położenia, z którego powinien wznowić odbieranie zdarzeń po ponownym uruchomieniu aplikacji. Jest on również używany przez klienta do równoważenia obciążenia wielu wystąpień aplikacji.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- connectionString
-
string
Parametry połączenia używane do nawiązywania połączenia z przestrzenią nazw usługi Event Hubs. Oczekiwano, że właściwości klucza współużytkowanego znajdują się w tych parametrach połączenia, ale nie w ścieżce centrum zdarzeń, np. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Nazwa określonego centrum zdarzeń do połączenia klienta.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- fullyQualifiedNamespace
-
string
Pełna przestrzeń nazw, która prawdopodobnie będzie podobna do .servicebus.windows.net
- eventHubName
-
string
Nazwa określonego centrum zdarzeń do połączenia klienta.
- credential
Obiekt poświadczeń używany przez klienta do uzyskiwania tokenu w celu uwierzytelnienia połączenia z usługą Azure Event Hubs.
Zobacz @azure/tożsamość, aby utworzyć poświadczenia obsługujące uwierzytelnianie usługi AAD. Użyj polecenia AzureNamedKeyCredential from @azure/core-auth, jeśli chcesz przekazać SharedAccessKeyNameSharedAccessKey parametry połączenia i bez użycia parametrów połączenia. Te pola są mapowanie odpowiednio na name pola i key w elemecie AzureNamedKeyCredential.
Użyj polecenia AzureSASCredential from @azure/core-auth, jeśli chcesz przekazać SharedAccessSignature element bez użycia parametrów połączenia. To pole jest mapowe na signature w pliku AzureSASCredential.
- checkpointStore
- CheckpointStore
Magazyn punktów kontrolnych używany przez klienta do odczytywania punktów kontrolnych w celu określenia położenia, z którego powinien wznowić odbieranie zdarzeń po ponownym uruchomieniu aplikacji. Jest on również używany przez klienta do równoważenia obciążenia wielu wystąpień aplikacji.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
Klasa EventHubConsumerClient służy do korzystania ze zdarzeń z centrum zdarzeń.
Użyj parametru options , aby skonfigurować zasady ponawiania prób lub ustawienia serwera proxy.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)Parametry
- consumerGroup
-
string
Nazwa grupy odbiorców, z której chcesz przetwarzać zdarzenia.
- fullyQualifiedNamespace
-
string
Pełna przestrzeń nazw, która prawdopodobnie będzie podobna do .servicebus.windows.net
- eventHubName
-
string
Nazwa określonego centrum zdarzeń do połączenia klienta.
- credential
Obiekt poświadczeń używany przez klienta do uzyskiwania tokenu w celu uwierzytelnienia połączenia z usługą Azure Event Hubs.
Zobacz @azure/tożsamość, aby utworzyć poświadczenia obsługujące uwierzytelnianie usługi AAD. Użyj polecenia AzureNamedKeyCredential from @azure/core-auth, jeśli chcesz przekazać SharedAccessKeyNameSharedAccessKey parametry połączenia i bez użycia parametrów połączenia. Te pola są mapowanie odpowiednio na name pola i key w elemecie AzureNamedKeyCredential.
Użyj polecenia AzureSASCredential from @azure/core-auth, jeśli chcesz przekazać SharedAccessSignature element bez użycia parametrów połączenia. To pole jest mapowe na signature w pliku AzureSASCredential.
- options
- EventHubConsumerClientOptions
Zestaw opcji do zastosowania podczas konfigurowania klienta.
-
retryOptions: Konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład:{ "maxRetries": 4 }lub{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: konfiguruje channelling połączenia AMQP za pośrednictwem web sockets. -
userAgent: ciąg dołączany do wbudowanego ciągu agenta użytkownika, który jest przekazywany do usługi.
Szczegóły właściwości
defaultConsumerGroupName
Nazwa domyślnej grupy odbiorców w usłudze Event Hubs.
static defaultConsumerGroupName: stringWartość właściwości
string
eventHubName
Nazwa wystąpienia centrum zdarzeń, dla którego jest tworzony ten klient.
string eventHubNameWartość właściwości
string
fullyQualifiedNamespace
W pełni kwalifikowana przestrzeń nazw wystąpienia centrum zdarzeń, dla którego jest tworzony ten klient. Prawdopodobnie będzie to podobne do .servicebus.windows.net.
string fullyQualifiedNamespaceWartość właściwości
string
identifier
Nazwa używana do identyfikowania tego elementu EventHubConsumerClient. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.
identifier: stringWartość właściwości
string
Szczegóły metody
close()
Zamyka połączenie AMQP z wystąpieniem centrum zdarzeń, zwracając obietnicę, która zostanie rozwiązana po zakończeniu rozłączenia.
function close(): Promise<void>Zwraca
Promise<void>
Obietnica
getEventHubProperties(GetEventHubPropertiesOptions)
Udostępnia informacje o środowisku uruchomieniowym centrum zdarzeń.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>Parametry
- options
- GetEventHubPropertiesOptions
Zestaw opcji do zastosowania do wywołania operacji.
Zwraca
Promise<EventHubProperties>
Obietnica, która rozwiązuje problem z informacjami o wystąpieniu centrum zdarzeń.
getPartitionIds(GetPartitionIdsOptions)
Zawiera identyfikator każdej partycji skojarzonej z centrum zdarzeń.
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>Parametry
- options
- GetPartitionIdsOptions
Zestaw opcji do zastosowania do wywołania operacji.
Zwraca
Promise<string[]>
Obietnica, która jest rozpoznawana za pomocą tablicy ciągów reprezentujących identyfikator dla każdej partycji skojarzonej z centrum zdarzeń.
getPartitionProperties(string, GetPartitionPropertiesOptions)
Zawiera informacje o stanie określonej partycji.
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>Parametry
- partitionId
-
string
Identyfikator partycji, dla której są wymagane informacje.
- options
- GetPartitionPropertiesOptions
Zestaw opcji do zastosowania do wywołania operacji.
Zwraca
Promise<PartitionProperties>
Obietnica, która rozwiązuje problem z informacjami o stanie partycji .
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
Subskrybowanie zdarzeń z jednej partycji. Wywołaj metodę close() dla zwróconego obiektu, aby zatrzymać odbieranie zdarzeń.
Przykład użycia:
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): SubscriptionParametry
- partitionId
-
string
Identyfikator partycji do subskrybowania.
- handlers
- SubscriptionEventHandlers
Programy obsługi dla cyklu życia subskrypcji — inicjowanie subskrypcji partycji, odbieranie zdarzeń, obsługa błędów i zamykanie subskrypcji w partycji.
- options
- SubscribeOptions
Konfiguruje sposób odbierania zdarzeń.
Najbardziej typowe są maxBatchSize i maxWaitTimeInSeconds kontrolują przepływ zdarzeń do programu obsługi dostarczonego w celu odbierania zdarzeń, a także położenia początkowego. Na przykład { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Zwraca
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Subskrybowanie zdarzeń ze wszystkich partycji.
Jeśli magazyn punktów kontrolnych jest dostarczany do EventHubConsumerClient obiektu i istnieje wiele wystąpień aplikacji, każde wystąpienie subskrybuuje podzbiór partycji, tak aby obciążenie było między nimi zrównoważone.
Wywołaj metodę close() dla zwróconego obiektu, aby zatrzymać odbieranie zdarzeń.
Przykład użycia:
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): SubscriptionParametry
- handlers
- SubscriptionEventHandlers
Programy obsługi dla cyklu życia subskrypcji — inicjowanie subskrypcji na partycję, odbieranie zdarzeń, obsługa błędów i zamykanie subskrypcji na partycję.
- options
- SubscribeOptions
Konfiguruje sposób odbierania zdarzeń.
Najbardziej typowe są maxBatchSize i maxWaitTimeInSeconds kontrolują przepływ zdarzeń do programu obsługi dostarczonego w celu odbierania zdarzeń, a także położenia początkowego. Na przykład { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }