EventHubClientOptions interface

Paket:
@azure/event-hubs

Menjelaskan opsi yang dapat disediakan saat membuat EventHubClient.

  • userAgent : String untuk ditambahkan ke string agen pengguna bawaan yang diteruskan sebagai properti koneksi ke layanan.
  • webSocketOptions : Opsi untuk mengonfigurasi saluran koneksi AMQP melalui Soket Web.
    • websocket : Konstruktor WebSocket yang digunakan untuk membuat koneksi AMQP jika Anda memilih untuk membuat koneksi melalui WebSocket.
    • webSocketConstructorOptions : Opsi untuk meneruskan ke konstruktor Websocket saat Anda memilih untuk membuat koneksi melalui WebSocket.
  • retryOptions : Opsi coba lagi untuk semua operasi pada klien/produsen/konsumen.
    • maxRetries : Berapa kali operasi dapat dicoba kembali jika terjadi kesalahan yang dapat dicoba kembali.
    • maxRetryDelayInMs: Penundaan maksimum antara percobaan ulang. Hanya berlaku saat melakukan percobaan ulang eksponensial.
    • mode: Mode coba lagi mana yang akan diterapkan, ditentukan oleh enum RetryMode. Opsinya Exponential dan Fixed. Default ke Fixed.
    • retryDelayInMs: Jumlah waktu untuk menunggu dalam milidetik sebelum melakukan upaya berikutnya. Ketika mode diatur ke Exponential, ini digunakan untuk menghitung penundaan yang meningkat secara eksponensial antara percobaan ulang. Default: 30000 milidetik.
    • timeoutInMs: Jumlah waktu dalam milidetik untuk menunggu sebelum waktu operasi habis. Ini akan memicu percobaan kembali jika ada upaya coba lagi yang tersisa. Nilai default: 60000 milidetik.

Penggunaan sederhana dapat { "maxRetries": 4 }.

Contoh penggunaan:

{
    retryOptions: {
        maxRetries: 4
    }
}

Properti

customEndpointAddress

Titik akhir kustom untuk digunakan saat menyambungkan ke layanan Azure Event Hubs. Ini dapat berguna ketika jaringan Anda tidak mengizinkan menyambungkan ke alamat titik akhir Azure Event Hubs standar, tetapi memungkinkan menyambungkan melalui perantara.

Contoh: "https://my.custom.endpoint:100/"
identifier

Nama unik yang digunakan untuk mengidentifikasi klien. Jika tidak disediakan, GUID akan digunakan sebagai pengidentifikasi
retryOptions

Opsi untuk mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Nilai yang ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan Azure Event Hubs.
webSocketOptions

Opsi untuk mengonfigurasi saluran koneksi AMQP melalui Soket Web.

Detail Properti

customEndpointAddress

Titik akhir kustom untuk digunakan saat menyambungkan ke layanan Azure Event Hubs. Ini dapat berguna ketika jaringan Anda tidak mengizinkan menyambungkan ke alamat titik akhir Azure Event Hubs standar, tetapi memungkinkan menyambungkan melalui perantara.

Contoh: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Nilai Properti

string

identifier

Nama unik yang digunakan untuk mengidentifikasi klien. Jika tidak disediakan, GUID akan digunakan sebagai pengidentifikasi

identifier?: string

Nilai Properti

string

retryOptions

Opsi untuk mengonfigurasi kebijakan coba lagi untuk semua operasi pada klien. Misalnya, { "maxRetries": 4 } atau { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Nilai Properti

RetryOptions

userAgent

Nilai yang ditambahkan ke string agen pengguna bawaan yang diteruskan ke layanan Azure Event Hubs.

userAgent?: string

Nilai Properti

string

webSocketOptions

Opsi untuk mengonfigurasi saluran koneksi AMQP melalui Soket Web.

webSocketOptions?: WebSocketOptions

Nilai Properti

WebSocketOptions