@azure/event-hubs package
Kelas
EventHubBufferedProducerClient |
Bergantung pada opsi yang ditentukan ketika peristiwa diantrekan, mereka dapat secara otomatis ditetapkan ke partisi, dikelompokkan sesuai dengan kunci partisi yang ditentukan, atau menetapkan partisi yang diminta secara khusus. Model ini dimaksudkan untuk menggeser beban manajemen batch dari pemanggil, dengan biaya waktu non-deterministik, kapan peristiwa akan diterbitkan. Ada trade-off tambahan yang perlu dipertimbangkan, juga:
Dalam skenario di mana penting untuk memiliki peristiwa yang segera diterbitkan dengan hasil deterministik, pastikan bahwa kunci partisi ditetapkan ke partisi yang konsisten dengan penerbit lain, atau di mana memaksimalkan ketersediaan adalah persyaratan, menggunakan |
EventHubConsumerClient |
Kelas Ada beberapa cara untuk membuat
Secara opsional, Anda juga dapat lulus:
|
EventHubProducerClient |
Kelas Ada beberapa cara untuk membuat
Secara opsional, Anda juga dapat meneruskan tas opsi untuk mengonfigurasi kebijakan percobaan kembali atau pengaturan proksi. |
MessagingError |
Menjelaskan kelas dasar untuk Kesalahan Olahpesan. |
Antarmuka
BufferedCloseOptions |
Opsi untuk mengonfigurasi |
BufferedFlushOptions |
Opsi untuk mengonfigurasi |
Checkpoint |
Titik pemeriksaan dimaksudkan untuk mewakili peristiwa terakhir yang berhasil diproses oleh pengguna dari partisi tertentu dari grup konsumen dalam instans Pusat Aktivitas.
Pengguna tidak pernah diharapkan untuk berinteraksi secara |
CheckpointStore |
Titik pemeriksaan menyimpan dan mengambil informasi kepemilikan partisi dan detail titik pemeriksaan untuk setiap partisi dalam grup konsumen tertentu dari instans pusat aktivitas. Pengguna tidak dimaksudkan untuk mengimplementasikan
|
CreateBatchOptions |
Opsi untuk mengonfigurasi
Contoh penggunaan:
|
EnqueueEventOptions |
Opsi untuk mengonfigurasi |
EventData |
Antarmuka yang menjelaskan data yang akan dikirim ke Pusat Aktivitas.
Gunakan ini sebagai referensi saat membuat objek yang akan dikirim saat menggunakan
|
EventDataAdapterParameters |
Parameter ke |
EventDataBatch |
Antarmuka yang mewakili batch peristiwa yang dapat digunakan untuk mengirim peristiwa ke Event Hub. Untuk membuat batch, gunakan |
EventHubBufferedProducerClientOptions |
Menjelaskan opsi yang dapat disediakan saat membuat |
EventHubClientOptions |
Menjelaskan opsi yang dapat disediakan saat membuat EventHubClient.
Penggunaan sederhana dapat berupa Contoh penggunaan:
|
EventHubConnectionStringProperties |
Kumpulan properti yang terdiri dari string koneksi Pusat Aktivitas. |
EventHubConsumerClientOptions |
Menjelaskan opsi yang dapat disediakan saat membuat EventHubConsumerClient.
Penggunaan sederhana dapat berupa Contoh penggunaan:
|
EventHubProperties |
Menjelaskan informasi runtime dari Pusat Aktivitas. |
EventPosition |
Mewakili posisi peristiwa dalam partisi Pusat Aktivitas, biasanya digunakan saat memanggil Untuk mendapatkan EventPosition yang mewakili awal atau akhir aliran, gunakan konstanta |
GetEventHubPropertiesOptions |
Kumpulan opsi untuk mengonfigurasi perilaku
|
GetPartitionIdsOptions |
Kumpulan opsi untuk mengonfigurasi perilaku
|
GetPartitionPropertiesOptions |
Kumpulan opsi untuk mengonfigurasi perilaku
|
LastEnqueuedEventProperties |
Sekumpulan informasi tentang peristiwa partisi antrean terakhir, seperti yang diamati oleh konsumen saat peristiwa diterima dari layanan Azure Event Hubs |
LoadBalancingOptions |
Tas opsi untuk mengonfigurasi pengaturan penyeimbangan beban. |
OnSendEventsErrorContext |
Berisi peristiwa yang tidak berhasil dikirim ke Pusat Aktivitas, partisi tempat mereka ditetapkan, dan kesalahan yang ditemui saat mengirim. |
OnSendEventsSuccessContext |
Berisi peristiwa yang berhasil dikirim ke Pusat Aktivitas, dan partisi tempat peristiwa tersebut ditetapkan. |
OperationOptions |
Opsi untuk mengonfigurasi pelacakan dan abortSignal. |
PartitionContext |
Antarmuka yang menjelaskan konteks yang diteruskan ke masing-masing fungsi yang merupakan bagian |
PartitionOwnership |
Antarmuka yang mewakili detail instans mana yang memiliki Catatan: Ini digunakan secara internal oleh |
PartitionProperties |
Menjelaskan informasi runtime dari Partisi EventHub. |
ReceivedEventData |
Antarmuka yang menjelaskan struktur peristiwa yang diterima dari Pusat Aktivitas.
Gunakan ini sebagai referensi saat membuat |
RetryOptions |
Coba lagi opsi kebijakan yang menentukan mode, jumlah percobaan ulang, interval coba lagi, dll. |
SendBatchOptions |
Opsi untuk mengonfigurasi
|
SubscribeOptions |
Opsi untuk mengonfigurasi |
Subscription |
Antarmuka yang menjelaskan objek yang dikembalikan oleh |
SubscriptionEventHandlers |
Antarmuka yang menjelaskan fungsi yang akan diimplementasikan oleh pengguna yang dipanggil oleh |
TokenCredential |
Mewakili kredensial yang mampu menyediakan token autentikasi. |
TryAddOptions |
Opsi untuk mengonfigurasi perilaku |
WebSocketImpl |
Menjelaskan bentuk konstruktor WebSocket yang diperlukan. |
WebSocketOptions |
Opsi untuk mengonfigurasi saluran koneksi AMQP melalui Web Sockets. |
Alias Jenis
ProcessCloseHandler |
Tanda tangan fungsi yang disediakan pengguna dipanggil |
ProcessErrorHandler |
Tanda tangan fungsi yang disediakan pengguna dipanggil oleh |
ProcessEventsHandler |
Tanda tangan fungsi yang disediakan pengguna dipanggil oleh |
ProcessInitializeHandler |
Tanda tangan fungsi yang disediakan pengguna dipanggil oleh |
Enum
CloseReason |
Enum yang mewakili berbagai alasan untuk |
RetryMode |
Menjelaskan jenis Mode Coba Lagi |
Fungsi
create |
Fungsi yang membangun adaptor data peristiwa. Adaptor tersebut dapat digunakan dengan |
parse |
Penguraian yang diberikan string koneksi ke dalam berbagai properti yang berlaku untuk Azure Event Hubs. Properti berguna untuk kemudian membangun EventHubProducerClient atau EventHubConsumerClient. |
Detail Fungsi
createEventDataAdapter(EventDataAdapterParameters)
Fungsi yang membangun adaptor data peristiwa. Adaptor tersebut dapat digunakan dengan @azure/schema-registry-avro
untuk mengodekan dan mendekode isi dalam data peristiwa.
function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>
Parameter
- params
- EventDataAdapterParameters
parameter untuk membuat data peristiwa
Mengembalikan
MessageAdapter<EventData>
Adaptor data peristiwa yang dapat menghasilkan dan menggunakan data peristiwa
parseEventHubConnectionString(string)
Penguraian yang diberikan string koneksi ke dalam berbagai properti yang berlaku untuk Azure Event Hubs. Properti berguna untuk kemudian membangun EventHubProducerClient atau EventHubConsumerClient.
function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>
Parameter
- connectionString
-
string
string koneksi yang terkait dengan Kebijakan Akses Bersama yang dibuat untuk namespace Layanan Pusat Aktivitas.
Mengembalikan
Readonly<EventHubConnectionStringProperties>