@azure/service-bus package

類別

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

介面

AuthorizationRule	表示 ATOM 型管理作業中 AuthorizationRule 的類型。
CorrelationRuleFilter	表示相互關聯篩選表達式。 CorrelationRuleFilter 會保存一組條件，這些條件會與訂用帳戶中傳入訊息的使用者和系統屬性相符。
CreateMessageBatchOptions	在 createBatch上設定 Sender 方法的選項。 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：進行下一次嘗試之前，以毫秒為單位等候的時間量。 當 mode 設定為 Exponential時，這會用來計算重試之間的指數增加延遲。 默認值：30000 毫秒。 timeoutInMs：作業逾時前等待的毫秒數。如果有剩餘的重試嘗試，這會觸發重試。 最小值：60000 毫秒。
ServiceBusConnectionStringProperties	組成服務總線連接字串的屬性集。
ServiceBusMessage	描述要傳送至服務總線的訊息。
ServiceBusMessageBatch	您可以使用 <xref:createBatch> 方法建立的訊息批次。
ServiceBusReceivedMessage	描述在查看作業期間從服務總線收到的訊息，因此無法解決。
ServiceBusReceiver	未處理會話的接收者。
ServiceBusReceiverOptions	建立接收者時要使用的選項。
ServiceBusRuleManager	允許管理訂用帳戶的規則。 此規則管理員只需要接聽宣告，而 ServiceBusAdministrationClient 需要管理宣告。
ServiceBusSender	寄件者可用來傳送訊息、排程稍後要傳送的訊息，以及取消這類排程的訊息。 使用 ServiceBusClient 上的 createSender 函式來具現化 Sender。 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