EventHubConsumerClient class

  • Referensi
Paket:
@azure/event-hubs

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas.

Ada beberapa cara untuk membuat EventHubConsumerClient

  • Gunakan string koneksi dari kebijakan SAS yang dibuat untuk instans Pusat Aktivitas Anda.
  • Gunakan string koneksi dari kebijakan SAS yang dibuat untuk namespace Layanan Pusat Aktivitas Anda, dan nama instans Pusat Aktivitas
  • Gunakan namespace lengkap seperti <yournamespace>.servicebus.windows.net, dan objek kredensial.

Secara opsional, Anda juga dapat meneruskan:

  • Tas opsi untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
  • Penyimpanan titik pemeriksaan yang digunakan oleh klien untuk membaca titik pemeriksaan untuk menentukan posisi dari mana ia harus melanjutkan menerima peristiwa saat aplikasi Anda dimulai ulang. Penyimpanan titik pemeriksaan juga digunakan oleh klien untuk menyeimbangkan beban beberapa instans aplikasi Anda.

Konstruktor

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

Properti

defaultConsumerGroupName

Nama grup konsumen default di layanan Azure Event Hubs.
eventHubName

Nama instans Pusat Aktivitas tempat klien ini dibuat.
fullyQualifiedNamespace

Namespace layanan yang sepenuhnya memenuhi syarat dari instans Pusat Aktivitas tempat klien ini dibuat. Ini kemungkinan mirip dengan .servicebus.windows.net.
identifier

Nama yang digunakan untuk mengidentifikasi EventHubConsumerClient ini. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.

Metode

close()

Menutup koneksi AMQP ke instans Pusat Aktivitas, mengembalikan janji yang akan diselesaikan saat pemutusan sambungan selesai.
getEventHubProperties(GetEventHubPropertiesOptions)

Menyediakan informasi runtime Event Hub.
getPartitionIds(GetPartitionIdsOptions)

Menyediakan id untuk setiap partisi yang terkait dengan Pusat Aktivitas.
getPartitionProperties(string, GetPartitionPropertiesOptions)

Menyediakan informasi tentang status partisi yang ditentukan.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Berlangganan peristiwa dari satu partisi. Panggil close() pada objek yang dikembalikan untuk berhenti menerima peristiwa.

Contoh penggunaan:

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)

Berlangganan peristiwa dari semua partisi.

Jika penyimpanan titik pemeriksaan disediakan untuk EventHubConsumerClient dan ada beberapa instans aplikasi Anda, maka setiap instans akan berlangganan subset partisi sehingga beban seimbang di antara mereka.

Panggil close() pada objek yang dikembalikan untuk berhenti menerima peristiwa.

Contoh penggunaan:

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 }
);

Detail Konstruktor

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

connectionString

string

String koneksi yang digunakan untuk menyambungkan ke instans Pusat Aktivitas. Diharapkan bahwa properti kunci bersama dan jalur Pusat Aktivitas terkandung dalam string koneksi ini. misalnya 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore
CheckpointStore

Penyimpanan titik pemeriksaan yang digunakan oleh klien untuk membaca titik pemeriksaan untuk menentukan posisi dari mana ia harus melanjutkan menerima peristiwa saat aplikasi Anda dimulai ulang. Ini juga digunakan oleh klien untuk menyeimbangkan beban beberapa instans aplikasi Anda.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Web Sockets.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

connectionString

string

String koneksi yang digunakan untuk menyambungkan ke instans Pusat Aktivitas. Diharapkan bahwa properti kunci bersama dan jalur Pusat Aktivitas terkandung dalam string koneksi ini. misalnya 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Web Sockets.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

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

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

connectionString

string

String koneksi yang digunakan untuk menyambungkan ke namespace Layanan Pusat Aktivitas. Diharapkan bahwa properti kunci bersama terkandung dalam string koneksi ini, tetapi bukan jalur Event Hub, misalnya 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Nama Event Hub tertentu untuk menyambungkan klien.

checkpointStore
CheckpointStore

Penyimpanan titik pemeriksaan yang digunakan oleh klien untuk membaca titik pemeriksaan untuk menentukan posisi dari mana ia harus melanjutkan menerima peristiwa saat aplikasi Anda dimulai ulang. Ini juga digunakan oleh klien untuk menyeimbangkan beban beberapa instans aplikasi Anda.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Soket Web.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

connectionString

string

String koneksi yang digunakan untuk menyambungkan ke namespace Layanan Pusat Aktivitas. Diharapkan bahwa properti kunci bersama terkandung dalam string koneksi ini, tetapi bukan jalur Event Hub, misalnya 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Nama Event Hub tertentu untuk menyambungkan klien.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Soket Web.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

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

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

fullyQualifiedNamespace

string

Namespace lengkap yang kemungkinan mirip dengan .servicebus.windows.net

eventHubName

string

Nama Event Hub tertentu untuk menyambungkan klien.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objek kredensial yang digunakan oleh klien untuk mendapatkan token untuk mengautentikasi koneksi dengan layanan Azure Event Hubs. Lihat @azure/identitas untuk membuat kredensial yang mendukung autentikasi AAD. AzureNamedKeyCredential Gunakan dari @azure/core-auth jika Anda ingin meneruskan SharedAccessKeyName dan SharedAccessKey tanpa menggunakan string koneksi. Bidang-bidang ini masing-masing memetakan ke name bidang dan key di AzureNamedKeyCredential. AzureSASCredential Gunakan dari @azure/core-auth jika Anda ingin meneruskan SharedAccessSignature tanpa menggunakan string koneksi. Bidang ini memetakan ke signature dalam AzureSASCredential.

checkpointStore
CheckpointStore

Penyimpanan titik pemeriksaan yang digunakan oleh klien untuk membaca titik pemeriksaan untuk menentukan posisi dari mana ia harus melanjutkan menerima peristiwa saat aplikasi Anda dimulai ulang. Ini juga digunakan oleh klien untuk menyeimbangkan beban beberapa instans aplikasi Anda.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Soket Web.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

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

Kelas EventHubConsumerClient ini digunakan untuk mengonsumsi peristiwa dari Pusat Aktivitas. options Gunakan parmeter untuk mengonfigurasi kebijakan coba lagi atau pengaturan proksi.

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

Parameter

consumerGroup

string

Nama grup konsumen tempat Anda ingin memproses peristiwa.

fullyQualifiedNamespace

string

Namespace lengkap yang kemungkinan mirip dengan .servicebus.windows.net

eventHubName

string

Nama Event Hub tertentu untuk menyambungkan klien.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objek kredensial yang digunakan oleh klien untuk mendapatkan token untuk mengautentikasi koneksi dengan layanan Azure Event Hubs. Lihat @azure/identitas untuk membuat kredensial yang mendukung autentikasi AAD. AzureNamedKeyCredential Gunakan dari @azure/core-auth jika Anda ingin meneruskan SharedAccessKeyName dan SharedAccessKey tanpa menggunakan string koneksi. Bidang-bidang ini masing-masing memetakan ke name bidang dan key di AzureNamedKeyCredential. AzureSASCredential Gunakan dari @azure/core-auth jika Anda ingin meneruskan SharedAccessSignature tanpa menggunakan string koneksi. Bidang ini memetakan ke signature dalam AzureSASCredential.

options
EventHubConsumerClientOptions

Sekumpulan opsi untuk diterapkan saat mengonfigurasi klien.

  • retryOptions : Mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Mengonfigurasi saluran koneksi AMQP melalui Soket Web.
  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan.

Detail Properti

defaultConsumerGroupName

Nama grup konsumen default di layanan Azure Event Hubs.

static defaultConsumerGroupName: string

Nilai Properti

string

eventHubName

Nama instans Pusat Aktivitas tempat klien ini dibuat.

string eventHubName

Nilai Properti

string

fullyQualifiedNamespace

Namespace layanan yang sepenuhnya memenuhi syarat dari instans Pusat Aktivitas tempat klien ini dibuat. Ini kemungkinan mirip dengan .servicebus.windows.net.

string fullyQualifiedNamespace

Nilai Properti

string

identifier

Nama yang digunakan untuk mengidentifikasi EventHubConsumerClient ini. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.

identifier: string

Nilai Properti

string

Detail Metode

close()

Menutup koneksi AMQP ke instans Pusat Aktivitas, mengembalikan janji yang akan diselesaikan saat pemutusan sambungan selesai.

function close(): Promise<void>

Mengembalikan

Promise<void>

Janji

getEventHubProperties(GetEventHubPropertiesOptions)

Menyediakan informasi runtime Event Hub.

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

Parameter

options
GetEventHubPropertiesOptions

Kumpulan opsi untuk diterapkan ke panggilan operasi.

Mengembalikan

Promise<EventHubProperties>

Janji yang diselesaikan dengan informasi tentang instans Pusat Aktivitas.

getPartitionIds(GetPartitionIdsOptions)

Menyediakan id untuk setiap partisi yang terkait dengan Pusat Aktivitas.

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

Parameter

options
GetPartitionIdsOptions

Kumpulan opsi untuk diterapkan ke panggilan operasi.

Mengembalikan

Promise<string[]>

Janji yang diselesaikan dengan Array string yang mewakili id untuk setiap partisi yang terkait dengan Event Hub.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Menyediakan informasi tentang status partisi yang ditentukan.

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

Parameter

partitionId

string

Id partisi yang informasinya diperlukan.

options
GetPartitionPropertiesOptions

Kumpulan opsi untuk diterapkan ke panggilan operasi.

Mengembalikan

Promise<PartitionProperties>

Janji yang diselesaikan dengan informasi tentang status partisi .

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Berlangganan peristiwa dari satu partisi. Panggil close() pada objek yang dikembalikan untuk berhenti menerima peristiwa.

Contoh penggunaan:

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

Parameter

partitionId

string

Id partisi untuk berlangganan.

handlers
SubscriptionEventHandlers

Handler untuk siklus hidup langganan - inisialisasi langganan partisi, menerima peristiwa, menangani kesalahan, dan penutupan langganan ke partisi.

options
SubscribeOptions

Mengonfigurasi cara peristiwa diterima. Paling umum adalah maxBatchSize dan maxWaitTimeInSeconds yang mengontrol alur peristiwa ke handler yang disediakan untuk menerima peristiwa serta posisi mulai. Misalnya, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Mengembalikan

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Berlangganan peristiwa dari semua partisi.

Jika penyimpanan titik pemeriksaan disediakan untuk EventHubConsumerClient dan ada beberapa instans aplikasi Anda, maka setiap instans akan berlangganan subset partisi sehingga beban seimbang di antara mereka.

Panggil close() pada objek yang dikembalikan untuk berhenti menerima peristiwa.

Contoh penggunaan:

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

Parameter

handlers
SubscriptionEventHandlers

Handler untuk siklus hidup langganan - inisialisasi langganan per partisi, menerima peristiwa, menangani kesalahan, dan penutupan langganan per partisi.

options
SubscribeOptions

Mengonfigurasi cara peristiwa diterima. Paling umum adalah maxBatchSize dan maxWaitTimeInSeconds yang mengontrol alur peristiwa ke handler yang disediakan untuk menerima peristiwa serta posisi mulai. Misalnya, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Mengembalikan

Subscription