EventHubConsumerClient class

Paket:

@azure/event-hubs

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır.

Oluşturmanın birden çok yolu vardır EventHubConsumerClient

• Olay Hub'ı örneğiniz için oluşturulan SAS ilkesinden bağlantı dizesini kullanın.
• Olay Hub'ı ad alanınız için oluşturulan SAS ilkesinden bağlantı dizesini ve Olay Hub'ı örneğinin adını kullanın
• gibi <yournamespace>.servicebus.windows.nettam ad alanını ve kimlik bilgileri nesnesini kullanın.

İsteğe bağlı olarak şunları da geçirebilirsiniz:

• Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için bir seçenek paketi.
• Uygulamanız yeniden başlatıldığında alma olaylarını sürdürmesi gereken konumu belirlemek üzere denetim noktalarını okumak için istemci tarafından kullanılan bir denetim noktası deposu. Denetim noktası deposu, istemci tarafından uygulamanızın birden çok örneğinin yükünü dengelemek için de kullanılır.

Oluşturucular

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)	EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

Özellikler

defaultConsumerGroupName	Event Hubs hizmetindeki varsayılan tüketici grubunun adı.
eventHubName	Bu istemcinin oluşturulduğu Olay Hub'ı örneğinin adı.
fullyQualifiedNamespace	Bu istemcinin oluşturulduğu Event Hub örneğinin tam ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.
identifier	Bu EventHubConsumerClient'ı tanımlamak için kullanılan ad. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

Yöntemler

close()	Olay Hub'ı örneğine yönelik AMQP bağlantısını kapatır ve bağlantı kesilmesi tamamlandığında çözülecek bir söz döndürür.
getEventHubProperties(GetEventHubPropertiesOptions)	Event Hub çalışma zamanı bilgilerini sağlar.
getPartitionIds(GetPartitionIdsOptions)	Olay Hub'ı ile ilişkili her bölümün kimliğini sağlar.
getPartitionProperties(string, GetPartitionPropertiesOptions)	Belirtilen bölümün durumu hakkında bilgi sağlar.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)	Tek bir bölümden olaylara abone olma. Olayları almayı durdurmak için döndürülen nesnede close() öğesini çağırın. Örnek kullanım: 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 } );
subscribe(SubscriptionEventHandlers, SubscribeOptions)	Tüm bölümlerdeki olaylara abone olun. denetim noktası deposu uygulamasına EventHubConsumerClient sağlanmışsa ve uygulamanızın birden çok örneği varsa, her örnek bölümlerin bir alt kümesine abone olur ve yük aralarında dengelenir. Olayları almayı durdurmak için döndürülen nesnede close() öğesini çağırın. Örnek kullanım: 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 } );

Oluşturucu Ayrıntıları

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

connectionString

string

Event Hub örneğine bağlanmak için kullanılacak bağlantı dizesi. Paylaşılan anahtar özelliklerinin ve Olay Hub'ı yolunun bu bağlantı dizesinde bulunması beklenir. örneğin'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore

CheckpointStore

uygulamanız yeniden başlatıldığında olayları alma işleminin sürdürüleceği konumu belirlemek üzere denetim noktalarını okumak için istemci tarafından kullanılan bir denetim noktası deposu. Ayrıca istemci tarafından uygulamanızın birden çok örneğini yük dengelemek için de kullanılır.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırılır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

connectionString

string

Event Hub örneğine bağlanmak için kullanılacak bağlantı dizesi. Paylaşılan anahtar özelliklerinin ve Olay Hub'ı yolunun bu bağlantı dizesinde bulunması beklenir. örneğin'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırılır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

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

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

connectionString

string

Event Hubs ad alanına bağlanmak için kullanılacak bağlantı dizesi. Paylaşılan anahtar özelliklerinin bu bağlantı dizesinde bulunması beklenir, ancak Olay Hub'ı yolunda yer almaması beklenir; örneğin, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

İstemcinin bağlanacak olay hub'ının adı.

checkpointStore

CheckpointStore

Uygulamanız yeniden başlatıldığında alma olaylarını sürdürmesi gereken konumu belirlemek üzere denetim noktalarını okumak için istemci tarafından kullanılan bir denetim noktası deposu. Ayrıca istemci tarafından uygulamanızın birden çok örneğinin yükünü dengelemek için de kullanılır.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

connectionString

string

Event Hubs ad alanına bağlanmak için kullanılacak bağlantı dizesi. Paylaşılan anahtar özelliklerinin bu bağlantı dizesinde bulunması beklenir, ancak Olay Hub'ı yolunda yer almaması beklenir; örneğin, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

İstemcinin bağlanacak olay hub'ının adı.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

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

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

fullyQualifiedNamespace

string

.servicebus.windows.net benzer olabilecek tam ad alanı

eventHubName

string

İstemcinin bağlanacak olay hub'ının adı.

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Event Hubs hizmetiyle bağlantının kimliğini doğrulamak üzere belirteci almak için istemci tarafından kullanılan bir kimlik bilgisi nesnesi. AAD kimlik doğrulamasını destekleyen kimlik bilgileri oluşturmak için bkz. @azure/kimlik. AzureNamedKeyCredential bağlantı dizesi kullanmadan ve SharedAccessKey geçirmek istiyorsanız SharedAccessKeyName from @azure/core-auth komutunu kullanın. Bu alanlar, içinde sırasıyla ve key alanıyla AzureNamedKeyCredentialeşlername. AzureSASCredential Bağlantı dizesi kullanmadan geçirmek istiyorsanız SharedAccessSignature from @azure/core-auth komutunu kullanın. Bu alan içinde AzureSASCredentialile signature eşler.

checkpointStore

CheckpointStore

Uygulamanız yeniden başlatıldığında alma olaylarını sürdürmesi gereken konumu belirlemek üzere denetim noktalarını okumak için istemci tarafından kullanılan bir denetim noktası deposu. Ayrıca istemci tarafından uygulamanızın birden çok örneğinin yükünü dengelemek için de kullanılır.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

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

EventHubConsumerClient sınıfı bir Olay Hub'ından olayları kullanmak için kullanılır. options Yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için parmeter'ı kullanın.

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

Parametreler

consumerGroup

string

Olayları işlemek istediğiniz tüketici grubunun adı.

fullyQualifiedNamespace

string

.servicebus.windows.net benzer olabilecek tam ad alanı

eventHubName

string

İstemcinin bağlanacak olay hub'ının adı.

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Event Hubs hizmetiyle bağlantının kimliğini doğrulamak üzere belirteci almak için istemci tarafından kullanılan bir kimlik bilgisi nesnesi. AAD kimlik doğrulamasını destekleyen kimlik bilgileri oluşturmak için bkz. @azure/kimlik. AzureNamedKeyCredential bağlantı dizesi kullanmadan ve SharedAccessKey geçirmek istiyorsanız SharedAccessKeyName from @azure/core-auth komutunu kullanın. Bu alanlar, içinde sırasıyla ve key alanıyla AzureNamedKeyCredentialeşlername. AzureSASCredential Bağlantı dizesi kullanmadan geçirmek istiyorsanız SharedAccessSignature from @azure/core-auth komutunu kullanın. Bu alan içinde AzureSASCredentialile signature eşler.

options

EventHubConsumerClientOptions

İstemciyi yapılandırırken uygulanacak bir dizi seçenek.

• retryOptions : İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırılır. Örneğin { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 } olabilir.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırır.
• userAgent : Hizmete geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.

Özellik Ayrıntıları

defaultConsumerGroupName

Event Hubs hizmetindeki varsayılan tüketici grubunun adı.

static defaultConsumerGroupName: string

Özellik Değeri

string

eventHubName

Bu istemcinin oluşturulduğu Olay Hub'ı örneğinin adı.

string eventHubName

Özellik Değeri

string

fullyQualifiedNamespace

Bu istemcinin oluşturulduğu Event Hub örneğinin tam ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.

string fullyQualifiedNamespace

Özellik Değeri

string

identifier

Bu EventHubConsumerClient'ı tanımlamak için kullanılan ad. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

identifier: string

Özellik Değeri

string

Yöntem Ayrıntıları

close()

Olay Hub'ı örneğine yönelik AMQP bağlantısını kapatır ve bağlantı kesilmesi tamamlandığında çözülecek bir söz döndürür.

function close(): Promise<void>

Döndürülenler

Promise<void>

Söz

getEventHubProperties(GetEventHubPropertiesOptions)

Event Hub çalışma zamanı bilgilerini sağlar.

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

Parametreler

options

GetEventHubPropertiesOptions

İşlem çağrısına uygulanacak seçenekler kümesi.

Döndürülenler

Promise<EventHubProperties>

Olay Hub'ı örneği hakkındaki bilgilerle çözülen bir söz.

getPartitionIds(GetPartitionIdsOptions)

Olay Hub'ı ile ilişkili her bölümün kimliğini sağlar.

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

Parametreler

options

GetPartitionIdsOptions

İşlem çağrısına uygulanacak seçenekler kümesi.

Döndürülenler

Promise<string[]>

Olay Hub'ı ile ilişkili her bölümün kimliğini temsil eden dize dizisiyle çözümleyen bir söz.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Belirtilen bölümün durumu hakkında bilgi sağlar.

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

Parametreler

partitionId

string

Bilgilerin gerekli olduğu bölümün kimliği.

options

GetPartitionPropertiesOptions

İşlem çağrısına uygulanacak seçenekler kümesi.

Döndürülenler

Promise<PartitionProperties>

Bölümün durumu hakkındaki bilgilerle çözümleyen bir söz.

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Tek bir bölümden olaylara abone olma. Olayları almayı durdurmak için döndürülen nesnede close() öğesini çağırın.

Örnek kullanım:

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): Subscription

Parametreler

partitionId

string

Abone olunacak bölümün kimliği.

handlers

SubscriptionEventHandlers

Aboneliğin yaşam döngüsü işleyicileri - bölümün abonelik başlatılması, olayları alma, hataları işleme ve bir aboneliğin bölüme kapatılması.

options

SubscribeOptions

Olayların alınma şeklini yapılandırılır. En yaygın olanı ve maxBatchSizemaxWaitTimeInSeconds hem olayları hem de başlangıç konumunu almak için sağlanan işleyiciye olay akışını denetler. Örneğin, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Döndürülenler

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Tüm bölümlerdeki olaylara abone olun.

denetim noktası deposu uygulamasına EventHubConsumerClient sağlanmışsa ve uygulamanızın birden çok örneği varsa, her örnek bölümlerin bir alt kümesine abone olur ve yük aralarında dengelenir.

Olayları almayı durdurmak için döndürülen nesnede close() öğesini çağırın.

Örnek kullanım:

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): Subscription

Parametreler

handlers

SubscriptionEventHandlers

Aboneliğin yaşam döngüsü işleyicileri - bölüm başına abonelik başlatma, olayları alma, hataları işleme ve bölüm başına aboneliği kapatma.

options

SubscribeOptions

Olayların alınma şeklini yapılandırılır. En yaygın olanı ve maxBatchSizemaxWaitTimeInSeconds hem olayları hem de başlangıç konumunu almak için sağlanan işleyiciye olay akışını denetler. Örneğin, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Döndürülenler

Subscription