ServiceBusClient class

Paket:

@azure/service-bus

Klien yang dapat membuat instans Pengirim untuk mengirim pesan ke antrean dan topik serta instans Penerima untuk menerima pesan dari antrean dan langganan.

Konstruktor

ServiceBusClient(string, ServiceBusClientOptions)	Membuat instans kelas ServiceBusClient yang dapat digunakan untuk membuat pengirim dan penerima ke namespace Azure Service Bus yang disediakan dalam string koneksi. Tidak ada koneksi yang dibuat ke layanan sampai pengirim/penerima yang dibuat dengan klien digunakan untuk mengirim/menerima pesan.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Membuat instans kelas ServiceBusClient yang dapat digunakan untuk membuat pengirim dan penerima ke namespace Azure Service Bus yang disediakan. Tidak ada koneksi yang dibuat ke layanan sampai pengirim/penerima yang dibuat dengan klien digunakan untuk mengirim/menerima pesan.

Properti

fullyQualifiedNamespace	Namespace layanan yang sepenuhnya memenuhi syarat dari instans Bus Layanan tempat klien ini dibuat. Ini kemungkinan mirip dengan <yournamespace.servicebus.windows.net>.
identifier	Nama yang digunakan untuk mengidentifikasi ServiceBusClient ini. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.

Metode

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Membuat penerima untuk sesi berikutnya yang tersedia dalam antrean Azure Service Bus yang mendukung sesi. Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Membuat penerima untuk sesi berikutnya yang tersedia dalam langganan Azure Service Bus yang mendukung sesi. Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Membuat penerima untuk antrean Azure Service Bus yang diaktifkan sesi. Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Membuat penerima untuk langganan Azure Service Bus yang diaktifkan sesi. Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Menutup koneksi AMQP yang mendasar. CATATAN: ini juga akan memutuskan sambungan instans Penerima atau Pengirim yang dibuat dari instans ini.
createReceiver(string, ServiceBusReceiverOptions)	Membuat penerima untuk antrean Azure Service Bus. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada penerima dipanggil. Untuk menargetkan sub antrean seperti antrean surat mati atau antrean surat mati transfer, berikan subQueue dalam opsi. Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada antrean, setelah itu mereka dikirim ke antrean surat mati terpisah. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Membuat penerima untuk langganan Azure Service Bus. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada penerima dipanggil. Untuk menargetkan sub antrean seperti antrean surat mati atau antrean surat mati transfer, berikan subQueue dalam opsi. Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete". Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean. Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima. Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada langganan, setelah itu mereka dikirim ke antrean surat mati terpisah. Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Membuat instans ServiceBusRuleManager yang digunakan untuk mengelola aturan untuk langganan.
createSender(string, ServiceBusSenderOptions)	Membuat Pengirim yang dapat digunakan untuk mengirim pesan, menjadwalkan pesan yang akan dikirim di lain waktu dan membatalkan pesan terjadwal tersebut. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada pengirim dipanggil.

Detail Konstruktor

ServiceBusClient(string, ServiceBusClientOptions)

Membuat instans kelas ServiceBusClient yang dapat digunakan untuk membuat pengirim dan penerima ke namespace Azure Service Bus yang disediakan dalam string koneksi. Tidak ada koneksi yang dibuat ke layanan sampai pengirim/penerima yang dibuat dengan klien digunakan untuk mengirim/menerima pesan.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Parameter

connectionString

string

String koneksi untuk namespace Azure Service Bus. CATATAN: string koneksi ini dapat berisi EntityPath, yang diabaikan.

options

ServiceBusClientOptions

Opsi untuk klien bus layanan.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Membuat instans kelas ServiceBusClient yang dapat digunakan untuk membuat pengirim dan penerima ke namespace Azure Service Bus yang disediakan. Tidak ada koneksi yang dibuat ke layanan sampai pengirim/penerima yang dibuat dengan klien digunakan untuk mengirim/menerima pesan.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Parameter

fullyQualifiedNamespace

string

Namespace lengkap instance Service Bus Anda yang kemungkinan mirip dengan <yournamespace.servicebus.windows.net>.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objek kredensial yang digunakan oleh klien untuk mendapatkan token untuk mengautentikasi koneksi dengan Azure Service Bus. Lihat @azure/identitas untuk membuat kredensial. Jika Anda menggunakan implementasi antarmuka TokenCredential sendiri terhadap AAD, atur "cakupan" agar bus layanan ["https://servicebus.azure.net//user_impersonation"] untuk mendapatkan token yang sesuai. Gunakan AzureNamedKeyCredential dari @azure/core-auth jika Anda ingin meneruskan SharedAccessKeyName dan SharedAccessKey tanpa menggunakan string koneksi. Bidang-bidang ini masing-masing dipetakan ke bidang name dan key di AzureNamedKeyCredential. Gunakan AzureSASCredential dari @azure/core-auth jika Anda ingin meneruskan SharedAccessSignature tanpa menggunakan string koneksi. Bidang ini memetakan ke signature di AzureSASCredential.

options

ServiceBusClientOptions

Sekumpulan opsi yang akan 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.

Detail Properti

fullyQualifiedNamespace

Namespace layanan yang sepenuhnya memenuhi syarat dari instans Bus Layanan tempat klien ini dibuat. Ini kemungkinan mirip dengan <yournamespace.servicebus.windows.net>.

fullyQualifiedNamespace: string

Nilai Properti

string

identifier

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

identifier: string

Nilai Properti

string

Detail Metode

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Membuat penerima untuk sesi berikutnya yang tersedia dalam antrean Azure Service Bus yang mendukung sesi.

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parameter

queueName

string

Nama antrean yang akan diterima.

options

ServiceBusSessionReceiverOptions

Opsi termasuk receiveMode (default ke peekLock), opsi untuk membuat penerima sesi.

Mengembalikan

Promise<ServiceBusSessionReceiver>

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Membuat penerima untuk sesi berikutnya yang tersedia dalam langganan Azure Service Bus yang mendukung sesi.

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parameter

topicName

string

Nama topik untuk langganan yang ingin kami terima.

subscriptionName

string

Nama langganan (di bawah topic) yang ingin kami terima.

options

ServiceBusSessionReceiverOptions

Opsi termasuk receiveMode (default ke peekLock), opsi untuk membuat penerima sesi.

Mengembalikan

Promise<ServiceBusSessionReceiver>

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Membuat penerima untuk antrean Azure Service Bus yang diaktifkan sesi.

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parameter

queueName

string

Nama antrean yang akan diterima.

sessionId

string

Id sesi tempat pesan perlu diterima

options

ServiceBusSessionReceiverOptions

Opsi termasuk receiveMode (default ke peekLock), opsi untuk membuat penerima sesi.

Mengembalikan

Promise<ServiceBusSessionReceiver>

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Membuat penerima untuk langganan Azure Service Bus yang diaktifkan sesi.

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parameter

topicName

string

Nama topik untuk langganan yang ingin kami terima.

subscriptionName

string

Nama langganan (di bawah topic) yang ingin kami terima.

sessionId

string

Id sesi tempat pesan perlu diterima

options

ServiceBusSessionReceiverOptions

Opsi termasuk receiveMode (default ke peekLock), opsi untuk membuat penerima sesi.

Mengembalikan

Promise<ServiceBusSessionReceiver>

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

close()

Menutup koneksi AMQP yang mendasar. CATATAN: ini juga akan memutuskan sambungan instans Penerima atau Pengirim yang dibuat dari instans ini.

function close(): Promise<void>

Mengembalikan

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Membuat penerima untuk antrean Azure Service Bus. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada penerima dipanggil.

Untuk menargetkan sub antrean seperti antrean surat mati atau antrean surat mati transfer, berikan subQueue dalam opsi. Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada antrean, setelah itu mereka dikirim ke antrean surat mati terpisah.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parameter

queueName

string

Nama antrean yang akan diterima.

options

ServiceBusReceiverOptions

Opsi untuk meneruskan receiveMode, default ke peekLock.

Mengembalikan

ServiceBusReceiver

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

createReceiver(string, string, ServiceBusReceiverOptions)

Membuat penerima untuk langganan Azure Service Bus. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada penerima dipanggil.

Untuk menargetkan sub antrean seperti antrean surat mati atau antrean surat mati transfer, berikan subQueue dalam opsi. Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Anda dapat memilih antara dua mode penerima: "peekLock" (default) dan "receiveAndDelete".

• Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean.
• Dalam mode receiveAndDelete, pesan dihapus dari Service Bus saat diterima.

Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada langganan, setelah itu mereka dikirim ke antrean surat mati terpisah.

Anda dapat menyelesaikan pesan dengan memanggil metode completeMessage(), abandonMessage(), deferMessage() atau deadletterMessage() pada penerima.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parameter

topicName

string

Nama topik untuk langganan yang ingin kami terima.

subscriptionName

string

Nama langganan (di bawah topic) yang ingin kami terima.

options

ServiceBusReceiverOptions

Opsi untuk meneruskan receiveMode, default ke peekLock.

Mengembalikan

ServiceBusReceiver

Penerima yang dapat digunakan untuk menerima, mengintip, dan menyelesaikan pesan.

createRuleManager(string, string)

Membuat instans ServiceBusRuleManager yang digunakan untuk mengelola aturan untuk langganan.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Parameter

topicName

string

topik untuk membuat ServiceBusRuleManager

subscriptionName

string

langganan khusus untuk topik yang ditentukan untuk membuat ServiceBusRuleManager.

Mengembalikan

ServiceBusRuleManager

ServiceBusRuleManager dilingkup ke langganan dan topik yang ditentukan.

createSender(string, ServiceBusSenderOptions)

Membuat Pengirim yang dapat digunakan untuk mengirim pesan, menjadwalkan pesan yang akan dikirim di lain waktu dan membatalkan pesan terjadwal tersebut. Tidak ada koneksi yang dibuat ke layanan sampai salah satu metode pada pengirim dipanggil.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Parameter

queueOrTopicName

string

Nama antrean atau topik untuk mengirim pesan.

options

ServiceBusSenderOptions

Mengembalikan

ServiceBusSender