@azure/service-bus package

類別

MessagingError	描述傳訊錯誤的基類。
ServiceBusAdministrationClient	所有作業都會傳回會解析為具有相關輸出之物件的承諾。 如果想要從服務存取直接回應，這些物件也有稱為 _response 的屬性，您可以使用此屬性。
ServiceBusClient	用戶端，可建立傳送者實例，以將訊息傳送至佇列和主題，以及接收者實例，以接收來自佇列和訂用帳戶的訊息。
ServiceBusError	服務匯流排內發生的錯誤。

介面

AuthorizationRule	表示 ATOM 型管理作業中的 類型 AuthorizationRule 。
CorrelationRuleFilter	表示相互關聯篩選運算式。 CorrelationRuleFilter 會保存一組條件，這些條件會與來自訂用帳戶之傳入訊息的使用者和系統屬性相符。
CreateMessageBatchOptions	在 上 Sender 設定 createBatch 方法的選項。 maxSizeInBytes：批次大小的上限。 使用方式範例： { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	代表佇列上的可設定選項
CreateSubscriptionOptions	代表訂用帳戶上的可設定選項
CreateTopicOptions	代表主題的可設定選項
DeadLetterOptions	描述使用 deadLetter() 從服務匯流排接收之訊息上的 方法，將訊息寄不出的信件原因和錯誤描述。
Delivery
GetMessageIteratorOptions	從服務匯流排取得可反覆運算器時的選項。
HttpHeader	HttpHeaders 集合中的個別標頭。
HttpHeadersLike	HTTP 標頭索引鍵/值組的集合。
HttpResponse	一律會出現 HTTP 回應上的屬性。
MessageHandlers	用於 streamMessages) 的一般訊息處理常式介面 (。
NamespaceProperties	表示與服務匯流排命名空間相關的中繼資料。
OperationOptions	所有作業的基底選項類型。
PeekMessagesOptions	描述傳遞至 peekMessages 接收者上 方法的選項。
ProcessErrorArgs	回呼的 processError 引數。
QueueProperties	表示 updateQueue 的輸入。
QueueRuntimeProperties	表示佇列實體的執行時間資訊屬性
ReceiveMessagesOptions	從服務匯流排接收訊息批次時的選項。
RetryOptions	決定模式、重試次數、重試間隔等重試原則選項。
RuleProperties	表示規則的所有屬性。
ServiceBusAdministrationClientOptions	表示 的 ServiceBusAdministrationClient 用戶端選項。
ServiceBusClientOptions	描述可在建立 ServiceBusClient 時提供的選項。 webSocketOptions ：透過 Web 通訊端設定 AMQP 連線通道的選項。 websocket ：如果您選擇透過 WebSocket 建立連線，則用來建立 AMQP 連線的 WebSocket 建構函式。 webSocketConstructorOptions ：當您選擇透過 WebSocket 建立連線時，要傳遞至 Websocket 建構函式的選項。 retryOptions ：用戶端上所有作業的重試選項。 maxRetries ：如果發生可重試的錯誤，可以重試作業的次數。 maxRetryDelayInMs：重試之間的延遲上限。 僅適用于執行指數重試時。 mode：要套用的重試模式，由列舉指定 RetryMode 。 選項為 Exponential 和 Fixed。 預設值為 Fixed。 retryDelayInMs：進行下一次嘗試之前，以毫秒為單位等候的時間量。 當 設定為 Exponential 時 mode ，這會用來計算重試之間的指數增加延遲。 預設值：30000 毫秒。 timeoutInMs：作業逾時前等候的毫秒時間量。如果剩餘任何重試嘗試，這會觸發重試。 最小值：60000 毫秒。
ServiceBusConnectionStringProperties	組成服務匯流排連接字串的屬性集。
ServiceBusMessage	描述要傳送至服務匯流排的訊息。
ServiceBusMessageBatch	您可以使用 方法建立 <xref:createBatch> 的訊息批次。
ServiceBusReceivedMessage	描述在查看作業期間從服務匯流排收到的訊息，因此無法解決。
ServiceBusReceiver	未處理會話的接收者。
ServiceBusReceiverOptions	建立接收者時要使用的選項。
ServiceBusRuleManager	允許管理訂用帳戶的規則。 此規則管理員只需要接聽宣告， 而 ServiceBusAdministrationClient 則需要管理宣告。
ServiceBusSender	傳送者可以用來傳送訊息、排程稍後要傳送的訊息，並取消這類排程的郵件。 使用 ServiceBusClient 上的 函 createSender 式來具現化傳送者。 Sender 類別是基礎 AMQP 寄件者連結的抽象概念。
ServiceBusSenderOptions	建立傳送者時要使用的選項。
ServiceBusSessionReceiver	處理會話的接收者，包括更新會話鎖定。
ServiceBusSessionReceiverOptions	描述使用已啟用會話的佇列/訂用帳戶時，傳遞給 acceptSession 和 acceptNextSession 方法的選項。
SqlRuleFilter	代表 SqlRuleFilter 上所有可能的欄位
SubscribeOptions	訂閱服務匯流排佇列或訂用帳戶時所使用的選項。
SubscriptionProperties	表示 updateSubscription 的輸入。
SubscriptionRuntimeProperties	表示訂閱實體的執行時間資訊屬性
TokenCredential	表示能夠提供驗證權杖的認證。
TopicProperties	表示 updateTopic 的輸入。
TopicRuntimeProperties	表示主題實體的執行時間資訊屬性
TryAddOptions	手動傳播 Span 分散式追蹤內容的選項組。
WebResourceLike	要對遠端伺服器提出 HTTP 要求的描述。
WebSocketImpl	描述 WebSocket 建構函式的必要圖形。
WebSocketOptions	透過 Web 通訊端設定 AMQP 連線通道的選項。

類型別名

EntitiesResponse	表示實體的清單作業結果，這些實體也包含 continuationToken 開始逐一查看的 。
EntityAvailabilityStatus	服務匯流排傳訊實體的可能值 availabilityStatus 。
EntityStatus	服務匯流排傳訊實體的可能值 status 。
OperationOptionsBase	注意：此類型旨在從 @azure/core-client OperationOptions 鏡像相關的欄位和結構 設定追蹤和中止的選項。
RawHttpHeaders	以簡單 JSON 物件表示的 HttpHeaders 集合。
ServiceBusErrorCode	服務匯流排失敗碼。
SqlRuleAction	代表 SqlRuleAction 上所有可能的欄位
TransferProgressEvent	引發以回應上傳或下載進度。
WithResponse	表示作業的傳迴響應以及原始回應。

列舉

RetryMode	描述重試模式類型
TokenType	描述支援的權杖類型。

函數

delay<T>(number, AbortSignalLike, string, T)	setTimeout 的包裝函式，可解析 t 毫秒之後的承諾。
isServiceBusError(unknown)	判斷錯誤是否為 類型 ServiceBusError
parseServiceBusConnectionString(string)	將指定的連接字串剖析為適用于Azure 服務匯流排的不同屬性。 然後建構 ServiceBusClient 的屬性很有用。

函式詳細資料

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

setTimeout 的包裝函式，可解析 t 毫秒之後的承諾。

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

參數

delayInMs

number

要延遲的毫秒數。

abortSignal

AbortSignalLike

與包含作業相關聯的 abortSignal。

abortErrorMsg

string

與包含作業相關聯的中止錯誤訊息。

value

T

在 t 毫秒的逾時之後，要解析的值。

傳回

Promise<T | void>

• 已解決的承諾

isServiceBusError(unknown)

判斷錯誤是否為 類型 ServiceBusError

function isServiceBusError(err: unknown): err

參數

err

unknown

檢查是否屬於 ServiceBusError 類型的錯誤

傳回

err

parseServiceBusConnectionString(string)

將指定的連接字串剖析為適用于Azure 服務匯流排的不同屬性。 然後建構 ServiceBusClient 的屬性很有用。

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

參數

connectionString

string

與針對服務匯流排命名空間、佇列或主題建立的共用存取原則相關聯的連接字串。

傳回

ServiceBusConnectionStringProperties