EventHubConsumerClient class

Пакет:: @azure/event-hubs

Класс EventHubConsumerClient используется для использования событий из концентратора событий.

Существует несколько способов создания EventHubConsumerClient

Используйте строку подключения из политики SAS, созданной для экземпляра Концентратора событий.
Используйте строку подключения из политики SAS, созданной для пространства имен Концентратора событий, и имя экземпляра Концентратора событий
Используйте полное пространство имен, например <yournamespace>.servicebus.windows.net, и объект учетных данных.

Кроме того, можно передать следующее:

Пакет параметров для настройки политики повторных попыток или параметров прокси-сервера.
Хранилище контрольных точек, которое используется клиентом для чтения контрольных точек, чтобы определить положение, из которого оно должно возобновить получение событий при перезапуске приложения. Хранилище контрольных точек также используется клиентом для балансировки нагрузки нескольких экземпляров приложения.

Конструкторы

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.
EventHubConsumerClient(string, string, string, TokenCredential \| NamedKeyCredential \| SASCredential, CheckpointStore, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.
EventHubConsumerClient(string, string, string, TokenCredential \| NamedKeyCredential \| SASCredential, EventHubConsumerClientOptions)	Класс `EventHubConsumerClient` используется для использования событий из концентратора событий. Используйте `options` parmeter для настройки политики повторных попыток или параметров прокси-сервера.

Свойства

defaultConsumerGroupName	Имя группы потребителей по умолчанию в службе Центров событий.
eventHubName	Имя экземпляра Концентратора событий, для которого создается этот клиент.
fullyQualifiedNamespace	Полное пространство имен экземпляра Концентратора событий, для которого создается этот клиент. Скорее всего, это будет похоже на <yournamespace.servicebus.windows.net>.
identifier	Имя, используемое для идентификации этого объекта EventHubConsumerClient. Если он не указан или не указан, будет создан случайный уникальный.

Методы

close()	Закрывает подключение AMQP к экземпляру Концентратора событий, возвращая обещание, которое будет разрешено при завершении отключения.
getEventHubProperties(GetEventHubPropertiesOptions)	Предоставляет сведения о среде выполнения Концентратора событий.
getPartitionIds(GetPartitionIdsOptions)	Предоставляет идентификатор для каждой секции, связанной с Концентратором событий.
getPartitionProperties(string, GetPartitionPropertiesOptions)	Предоставляет сведения о состоянии указанной секции.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)	Подписка на события из одной секции. Вызов close() для возвращаемого объекта, чтобы остановить получение событий. Пример использования: import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs"; const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName"); const partitionIds = await client.getPartitionIds(); const subscription = client.subscribe( partitionIds[0], { processEvents: async (events, context) => { console.log("Received event count: ", events.length); }, processError: async (err, context) => { console.log("Error: ", err); }, }, { startPosition: earliestEventPosition }, );
subscribe(SubscriptionEventHandlers, SubscribeOptions)	Подпишитесь на события из всех разделов. Если хранилище контрольных точек предоставляется `EventHubConsumerClient` и существует несколько экземпляров приложения, каждый экземпляр будет подписываться на подмножество секций, чтобы балансировка нагрузки была сбалансирована между ними. Вызов close() для возвращаемого объекта, чтобы остановить получение событий. Пример использования: `import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs"; const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName"); const subscription = client.subscribe( { processEvents: async (events, context) => { console.log("Received event count: ", events.length); }, processError: async (err, context) => { console.log("Error: ", err); }, }, { startPosition: earliestEventPosition }, );`

Сведения о конструкторе

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Класс EventHubConsumerClient используется для использования событий из концентратора событий. Используйте options parmeter для настройки политики повторных попыток или параметров прокси-сервера.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

connectionString: string

Строка подключения, используемая для подключения к экземпляру Концентратора событий. Ожидается, что свойства общего ключа и путь концентратора событий содержатся в этой строке подключения. Например, "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore: CheckpointStore

Хранилище контрольных точек, которое используется клиентом для чтения контрольных точек, чтобы определить положение, из которого оно должно возобновить получение событий при перезапуске приложения. Он также используется клиентом для балансировки нагрузки нескольких экземпляров приложения.

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

connectionString: string

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

connectionString: string

Строка подключения, используемая для подключения к пространству имен Центров событий. Ожидается, что свойства общего ключа содержатся в этой строке подключения, но не в пути концентратора событий, например Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName: string

Имя конкретного концентратора событий для подключения клиента к нему.

checkpointStore: CheckpointStore

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

connectionString: string

eventHubName: string

Имя конкретного концентратора событий для подключения клиента к нему.

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

fullyQualifiedNamespace: string

Полное пространство имен, которое, скорее всего, будет похоже на <вашепространство> имен.servicebus.windows.net

eventHubName: string

Имя конкретного концентратора событий для подключения клиента к нему.

credential: TokenCredential | NamedKeyCredential | SASCredential

Объект учетных данных, используемый клиентом для получения маркера для проверки подлинности подключения к службе Центров событий Azure. Сведения о создании учетных данных, поддерживающих проверку подлинности AAD, см. в разделе @azure/identity. Используйте AzureNamedKeyCredential из @azure/core-auth, если вы хотите передать SharedAccessKeyName и SharedAccessKey без использования строки подключения. Эти поля сопоставляют с полем name и key соответственно в AzureNamedKeyCredential. Используйте AzureSASCredential из @azure/core-auth, если вы хотите передать SharedAccessSignature без использования строки подключения. Это поле сопоставляется с signature в AzureSASCredential.

checkpointStore: CheckpointStore

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

Параметры

consumerGroup: string

Имя группы потребителей, из которой требуется обработать события.

fullyQualifiedNamespace: string

Полное пространство имен, которое, скорее всего, будет похоже на <вашепространство> имен.servicebus.windows.net

eventHubName: string

Имя конкретного концентратора событий для подключения клиента к нему.

credential: TokenCredential | NamedKeyCredential | SASCredential

options: EventHubConsumerClientOptions

Набор параметров, применяемых при настройке клиента.

retryOptions. Настраивает политику повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
webSocketOptions. Настраивает каналирование подключения AMQP через веб-сокеты.
userAgent: строка, добавляемая к встроенной строке агента пользователя, передаваемой в службу.

Сведения о свойстве

defaultConsumerGroupName

Имя группы потребителей по умолчанию в службе Центров событий.

static defaultConsumerGroupName: string

Значение свойства

string

eventHubName

Имя экземпляра Концентратора событий, для которого создается этот клиент.

string eventHubName

Значение свойства

string

fullyQualifiedNamespace

Полное пространство имен экземпляра Концентратора событий, для которого создается этот клиент. Скорее всего, это будет похоже на <yournamespace.servicebus.windows.net>.

string fullyQualifiedNamespace

Значение свойства

string

identifier

Имя, используемое для идентификации этого объекта EventHubConsumerClient. Если он не указан или не указан, будет создан случайный уникальный.

identifier: string

Значение свойства

string

Сведения о методе

close()

Закрывает подключение AMQP к экземпляру Концентратора событий, возвращая обещание, которое будет разрешено при завершении отключения.

function close(): Promise<void>

Возвращаемое значение

Promise<void>

Обещание<не выполнено>

getEventHubProperties(GetEventHubPropertiesOptions)

Предоставляет сведения о среде выполнения Концентратора событий.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

Параметры

options: GetEventHubPropertiesOptions

Набор параметров для применения к вызову операции.

Возвращаемое значение

Promise<EventHubProperties>

Обещание, разрешающее сведения об экземпляре Концентратора событий.

getPartitionIds(GetPartitionIdsOptions)

Предоставляет идентификатор для каждой секции, связанной с Концентратором событий.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

Параметры

options: GetPartitionIdsOptions

Набор параметров для применения к вызову операции.

Возвращаемое значение

Promise<string[]>

Обещание, разрешающее массив строк, представляющий идентификатор для каждой секции, связанной с Концентратором событий.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Предоставляет сведения о состоянии указанной секции.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

Параметры

partitionId: string

Идентификатор раздела, для которого требуется информация.

options: GetPartitionPropertiesOptions

Набор параметров для применения к вызову операции.

Возвращаемое значение

Promise<PartitionProperties>

Обещание, разрешающее сведения о состоянии секции.

Подписка на события из одной секции. Вызов close() для возвращаемого объекта, чтобы остановить получение событий.

Пример использования:

import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs";

const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName");

const partitionIds = await client.getPartitionIds();

const subscription = client.subscribe(
  partitionIds[0],
  {
    processEvents: async (events, context) => {
      console.log("Received event count: ", events.length);
    },
    processError: async (err, context) => {
      console.log("Error: ", err);
    },
  },
  { startPosition: earliestEventPosition },
);

function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

Параметры

partitionId: string

Идентификатор секции, на который нужно подписаться.

handlers: SubscriptionEventHandlers

Обработчики жизненного цикла подписки — инициализация подписки секции, получение событий, обработка ошибок и закрытие подписки на секцию.

options: SubscribeOptions

Настраивает способ получения событий. Наиболее распространенными являются maxBatchSize и maxWaitTimeInSeconds, которые управляют потоком событий обработчика, предоставленным для получения событий, а также начальной позиции. Например, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Возвращаемое значение

Subscription

Подпишитесь на события из всех разделов.

Если хранилище контрольных точек предоставляется EventHubConsumerClient и существует несколько экземпляров приложения, каждый экземпляр будет подписываться на подмножество секций, чтобы балансировка нагрузки была сбалансирована между ними.

Вызов close() для возвращаемого объекта, чтобы остановить получение событий.

Пример использования:

import { EventHubConsumerClient, earliestEventPosition } from "@azure/event-hubs";

const client = new EventHubConsumerClient("my-consumer-group", "connectionString", "eventHubName");

const subscription = client.subscribe(
  {
    processEvents: async (events, context) => {
      console.log("Received event count: ", events.length);
    },
    processError: async (err, context) => {
      console.log("Error: ", err);
    },
  },
  { startPosition: earliestEventPosition },
);

function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

Параметры

handlers: SubscriptionEventHandlers

Обработчики жизненного цикла подписки — инициализация подписки на секцию, получение событий, обработка ошибок и закрытие подписки на секцию.

options: SubscribeOptions

Возвращаемое значение

Subscription

Поделиться через

EventHubConsumerClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Параметры

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

Параметры

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

Параметры

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

Параметры

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

Параметры

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

Параметры

Сведения о свойстве

defaultConsumerGroupName

Значение свойства

eventHubName

Значение свойства

fullyQualifiedNamespace

Значение свойства

identifier

Значение свойства

Сведения о методе

close()

Возвращаемое значение

getEventHubProperties(GetEventHubPropertiesOptions)

Параметры

Возвращаемое значение

getPartitionIds(GetPartitionIdsOptions)

Параметры

Возвращаемое значение

getPartitionProperties(string, GetPartitionPropertiesOptions)

Параметры

Возвращаемое значение

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Параметры

Возвращаемое значение

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Параметры

Возвращаемое значение