@azure/service-bus package

Kelas

MessagingError	Menjelaskan kelas dasar untuk Kesalahan Olahpesan.
ServiceBusAdministrationClient	Semua operasi mengembalikan janji yang diselesaikan ke objek yang memiliki output yang relevan. Objek ini juga memiliki properti yang disebut _response yang dapat Anda gunakan jika Anda ingin mengakses respons langsung dari layanan.
ServiceBusClient	Klien yang dapat membuat instans Pengirim untuk mengirim pesan ke antrean dan topik serta instans Penerima untuk menerima pesan dari antrean dan langganan.
ServiceBusError	Kesalahan yang terjadi dalam Azure Service Bus.

Antarmuka

AuthorizationRule	Mewakili jenis AuthorizationRule dalam operasi manajemen berbasis ATOM.
CorrelationRuleFilter	Mewakili ekspresi filter korelasi. CorrelationRuleFilter menyimpan serangkaian kondisi yang cocok dengan properti pengguna dan sistem pesan masuk dari Langganan.
CreateMessageBatchOptions	Opsi untuk mengonfigurasi createBatch metode pada Sender. maxSizeInBytes: Batas atas untuk ukuran batch. Contoh penggunaan: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Mewakili opsi yang dapat diatur pada antrean
CreateSubscriptionOptions	Mewakili opsi yang dapat diatur pada langganan
CreateTopicOptions	Mewakili opsi yang dapat diatur pada topik
DeadLetterOptions	Menjelaskan alasan dan deskripsi kesalahan untuk dead-letter pesan menggunakan deadLetter() metode pada pesan yang diterima dari Azure Service Bus.
Delivery
GetMessageIteratorOptions	Opsi saat mendapatkan iterator yang dapat diulang dari Azure Service Bus.
HttpHeader	Header individual dalam koleksi HttpHeaders.
HttpHeadersLike	Kumpulan pasangan kunci/nilai header HTTP.
HttpResponse	Properti pada respons HTTP yang akan selalu ada.
MessageHandlers	Antarmuka handler pesan umum (digunakan untuk streamMessages).
NamespaceProperties	Mewakili metadata yang terkait dengan namespace bus layanan.
OperationOptions	Jenis opsi dasar untuk semua operasi.
PeekMessagesOptions	Menjelaskan opsi yang diteruskan ke peekMessages metode pada penerima.
ProcessErrorArgs	Argumen untuk processError panggilan balik.
QueueProperties	Mewakili input untuk updateQueue.
QueueRuntimeProperties	Mewakili atribut info runtime entitas antrean
ReceiveMessagesOptions	Opsi saat menerima batch pesan dari Azure Service Bus.
RetryOptions	Coba lagi opsi kebijakan yang menentukan mode, jumlah percobaan ulang, interval coba lagi, dll.
RuleProperties	Mewakili semua atribut aturan.
ServiceBusAdministrationClientOptions	Mewakili opsi klien dari ServiceBusAdministrationClient.
ServiceBusClientOptions	Menjelaskan opsi yang dapat disediakan saat membuat ServiceBusClient. 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. 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 RetryMode enum. Opsinya adalah: 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 antar 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 minimum: 60000 milidetik.
ServiceBusConnectionStringProperties	Kumpulan properti yang terdiri dari string koneksi Bus Layanan.
ServiceBusMessage	Menjelaskan pesan yang akan dikirim ke Azure Service Bus.
ServiceBusMessageBatch	Batch pesan yang dapat Anda buat menggunakan metode .<xref:createBatch>
ServiceBusReceivedMessage	Menjelaskan pesan yang diterima dari Azure Service Bus selama operasi intip sehingga tidak dapat diselesaikan.
ServiceBusReceiver	Penerima yang tidak menangani sesi.
ServiceBusReceiverOptions	Opsi untuk digunakan saat membuat penerima.
ServiceBusRuleManager	Memungkinkan aturan untuk langganan dikelola. Manajer aturan ini hanya memerlukan klaim Dengar, sedangkan ServiceBusAdministrationClient memerlukan kelola klaim.
ServiceBusSender	Pengirim dapat digunakan untuk mengirim pesan, menjadwalkan pesan yang akan dikirim di lain waktu dan membatalkan pesan terjadwal tersebut. createSender Gunakan fungsi pada ServiceBusClient untuk membuat instans Pengirim. Kelas Pengirim adalah abstraksi atas tautan pengirim AMQP yang mendasar.
ServiceBusSenderOptions	Opsi untuk digunakan saat membuat pengirim.
ServiceBusSessionReceiver	Penerima yang menangani sesi, termasuk memperbarui kunci sesi.
ServiceBusSessionReceiverOptions	Menjelaskan opsi yang diteruskan ke acceptSession metode dan acceptNextSession saat menggunakan Antrean/Langganan yang mengaktifkan sesi.
SqlRuleFilter	Mewakili semua bidang yang mungkin di SqlRuleFilter
SubscribeOptions	Opsi yang digunakan saat berlangganan antrean atau langganan Azure Service Bus.
SubscriptionProperties	Mewakili input untuk updateSubscription.
SubscriptionRuntimeProperties	Mewakili atribut info runtime entitas langganan
TokenCredential	Mewakili kredensial yang mampu menyediakan token autentikasi.
TopicProperties	Mewakili input untuk updateTopic.
TopicRuntimeProperties	Mewakili atribut info runtime entitas topik
TryAddOptions	Kumpulan opsi untuk menyebarkan Span konteks secara manual untuk pelacakan terdistribusi.
WebResourceLike	Deskripsi permintaan HTTP yang akan dibuat ke server jarak jauh.
WebSocketImpl	Menjelaskan bentuk konstruktor WebSocket yang diperlukan.
WebSocketOptions	Opsi untuk mengonfigurasi saluran koneksi AMQP melalui Soket Web.

Alias Jenis

EntitiesResponse	Mewakili hasil operasi daftar pada entitas yang juga berisi continuationToken untuk mulai melakukan iterasi.
EntityAvailabilityStatus	Nilai yang mungkin untuk availabilityStatus entitas olahpesan Azure Service Bus.
EntityStatus	Nilai yang mungkin untuk status entitas olahpesan Azure Service Bus.
OperationOptionsBase	CATATAN: Jenis ini dimaksudkan untuk mencerminkan bidang dan struktur yang relevan dari @azure/core-client OperationOptions Opsi untuk mengonfigurasi pelacakan dan abortSignal.
RawHttpHeaders	Koleksi HttpHeaders direpresentasikan sebagai objek JSON sederhana.
ServiceBusErrorCode	Kode kegagalan Azure Service Bus.
SqlRuleAction	Mewakili semua bidang yang mungkin di SqlRuleAction
TransferProgressEvent	Diaktifkan sebagai respons terhadap kemajuan unggahan atau pengunduhan.
WithResponse	Mewakili respons operasi yang dikembalikan bersama dengan respons mentah.

Enum

RetryMode	Menjelaskan jenis Mode Coba Lagi
TokenType	Menjelaskan jenis token yang didukung.

Fungsi

delay<T>(number, AbortSignalLike, string, T)	Pembungkus untuk setTimeout yang menyelesaikan janji setelah t milidetik.
isServiceBusError(unknown)	Menentukan apakah kesalahan berjenis ServiceBusError
parseServiceBusConnectionString(string)	Mengurai string koneksi yang diberikan ke dalam properti berbeda yang berlaku untuk Azure Service Bus. Properti berguna untuk kemudian membuat ServiceBusClient.

Detail Fungsi

delay<T>(number, AbortSignalLike, string, T)

Pembungkus untuk setTimeout yang menyelesaikan janji setelah t milidetik.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parameter

delayInMs

number

Jumlah milidetik yang akan ditunda.

abortSignal

AbortSignalLike

abortSignal yang terkait dengan operasi yang berisi.

abortErrorMsg

string

Pesan kesalahan batalkan yang terkait dengan operasi yang berisi.

value

T

Nilai yang akan diselesaikan setelah batas waktu t milidetik.

Mengembalikan

Promise<T | void>

• Janji terselesaikan

isServiceBusError(unknown)

Menentukan apakah kesalahan berjenis ServiceBusError

function isServiceBusError(err: unknown): err

Parameter

err

unknown

Kesalahan untuk memeriksa apakah jenisnya adalah ServiceBusError

Mengembalikan

err

parseServiceBusConnectionString(string)

Mengurai string koneksi yang diberikan ke dalam properti berbeda yang berlaku untuk Azure Service Bus. Properti berguna untuk kemudian membuat ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parameter

connectionString

string

String koneksi yang terkait dengan Kebijakan Akses Bersama yang dibuat untuk namespace, antrean, atau topik Bus Layanan.

Mengembalikan

ServiceBusConnectionStringProperties