ServiceBusClient class

套件:

@azure/service-bus

用戶端，可建立傳送者實例，以將訊息傳送至佇列和主題，以及接收者實例，以接收來自佇列和訂用帳戶的訊息。

建構函式

ServiceBusClient(string, ServiceBusClientOptions)	建立 ServiceBusClient 類別的實例，可用來建立連接字串中所提供之Azure 服務匯流排命名空間的傳送者和接收者。 除非使用用戶端建立的傳送者/接收者用來傳送/接收訊息，否則不會與服務建立連線。
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	建立 ServiceBusClient 類別的實例，可用來建立提供給Azure 服務匯流排命名空間的傳送者和接收者。 除非使用用戶端建立的傳送者/接收者用來傳送/接收訊息，否則不會與服務建立連線。

屬性

fullyQualifiedNamespace	建立此用戶端之服務匯流排實例的完整命名空間。 這可能類似于 .servicebus.windows.net。
identifier	用來識別此 ServiceBusClient 的名稱。 如果未指定或空白，則會產生隨機唯一的 。

方法

acceptNextSession(string, ServiceBusSessionReceiverOptions)	為啟用會話Azure 服務匯流排佇列中的下一個可用會話建立接收者。 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	在啟用會話Azure 服務匯流排訂用帳戶中，為下一個可用的會話建立接收者。 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	建立啟用會話的接收者Azure 服務匯流排佇列。 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	建立啟用會話Azure 服務匯流排訂用帳戶的接收者。 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	關閉基礎 AMQP 連線。 注意：這也會中斷從這個實例建立的任何接收者或傳送者實例的連線。
createReceiver(string, ServiceBusReceiverOptions)	建立Azure 服務匯流排佇列的接收者。 在呼叫接收者上的其中一個方法之前，不會連線到服務。 若要以寄不出的信件佇列或傳送寄不出的信件佇列之類的子佇列為目標，請在 選項中提供 subQueue 。 若要深入瞭解無效信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 未在鎖定期間內結算的訊息，將會重新傳遞佇列上設定的傳遞計數上限次數，之後才會傳送至個別的寄不出的信件佇列。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	建立Azure 服務匯流排訂閱的接收者。 在呼叫接收者上的其中一個方法之前，不會連線到服務。 若要以寄不出的信件佇列或傳送寄不出的信件佇列之類的子佇列為目標，請在 選項中提供 subQueue 。 若要深入瞭解無效信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues 您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。 未在鎖定期間內結算的訊息，將會重新傳遞訂用帳戶上設定的傳遞計數上限次數，之後才會傳送至個別的寄不出的信件佇列。 您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。 如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	建立用來管理訂用帳戶規則的 ServiceBusRuleManager 實例。
createSender(string, ServiceBusSenderOptions)	建立可用來傳送訊息的寄件者、排程稍後要傳送的訊息，以及取消這類排程的郵件。 在呼叫傳送者上的其中一個方法之前，不會與服務建立任何連線。

建構函式詳細資料

ServiceBusClient(string, ServiceBusClientOptions)

建立 ServiceBusClient 類別的實例，可用來建立連接字串中所提供之Azure 服務匯流排命名空間的傳送者和接收者。 除非使用用戶端建立的傳送者/接收者用來傳送/接收訊息，否則不會與服務建立連線。

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

參數

connectionString

string

Azure 服務匯流排命名空間的連接字串。 注意：此連接字串可以包含會忽略的 EntityPath。

options

ServiceBusClientOptions

服務匯流排用戶端的選項。

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

建立 ServiceBusClient 類別的實例，可用來建立提供給Azure 服務匯流排命名空間的傳送者和接收者。 除非使用用戶端建立的傳送者/接收者用來傳送/接收訊息，否則不會與服務建立連線。

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

參數

fullyQualifiedNamespace

string

服務匯流排實例的完整命名空間，可能類似于 .servicebus.windows.net。

credential

TokenCredential | NamedKeyCredential | SASCredential

用戶端用來取得權杖的認證物件，用來向Azure 服務匯流排驗證連線。 如需建立認證，請參閱@azure/身分識別。 如果您要對 AAD 使用自己的介面實 TokenCredential 作，請將服務匯流排的「範圍」設定為 ["https://servicebus.azure.net//user_impersonation"] 取得適當的權杖。 AzureNamedKeyCredential如果您想要傳入 SharedAccessKeyName ， SharedAccessKey 而不要使用連接字串，請使用 from @azure/core-auth。 這些欄位分別對應至 name 中的 AzureNamedKeyCredential 和 key 欄位。 AzureSASCredential如果您想要 SharedAccessSignature 傳入 而不使用連接字串，請使用 from @azure/core-auth。 此欄位對應至 signature 中的 AzureSASCredential 。

options

ServiceBusClientOptions

設定用戶端時要套用的一組選項。

• retryOptions ：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。
• webSocketOptions：設定透過 Web 通訊端的 AMQP 連線通道。

屬性詳細資料

fullyQualifiedNamespace

建立此用戶端之服務匯流排實例的完整命名空間。 這可能類似于 .servicebus.windows.net。

fullyQualifiedNamespace: string

屬性值

string

identifier

用來識別此 ServiceBusClient 的名稱。 如果未指定或空白，則會產生隨機唯一的 。

identifier: string

屬性值

string

方法詳細資料

acceptNextSession(string, ServiceBusSessionReceiverOptions)

為啟用會話Azure 服務匯流排佇列中的下一個可用會話建立接收者。

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

參數

queueName

string

要接收的佇列名稱。

options

ServiceBusSessionReceiverOptions

選項包括 receiveMode (預設為 peekLock) 、建立會話接收器的選項。

傳回

Promise<ServiceBusSessionReceiver>

可用來接收、查看和結算訊息的接收者。

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

在啟用會話Azure 服務匯流排訂用帳戶中，為下一個可用的會話建立接收者。

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

參數

topicName

string

我們想要接收之訂用帳戶的主題名稱。

subscriptionName

string

我們想要接收之) 下的 topic 訂用帳戶名稱 (。

options

ServiceBusSessionReceiverOptions

選項包括 receiveMode (預設為 peekLock) 、建立會話接收器的選項。

傳回

Promise<ServiceBusSessionReceiver>

可用來接收、查看和結算訊息的接收者。

acceptSession(string, string, ServiceBusSessionReceiverOptions)

建立啟用會話的接收者Azure 服務匯流排佇列。

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

參數

queueName

string

要接收的佇列名稱。

sessionId

string

需要接收訊息的會話識別碼

options

ServiceBusSessionReceiverOptions

選項包括 receiveMode (預設為 peekLock) 、建立會話接收器的選項。

傳回

Promise<ServiceBusSessionReceiver>

可用來接收、查看和結算訊息的接收者。

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

建立啟用會話Azure 服務匯流排訂用帳戶的接收者。

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： 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>

參數

topicName

string

我們想要接收之訂用帳戶的主題名稱。

subscriptionName

string

我們想要接收之) 下的 topic 訂用帳戶名稱 (。

sessionId

string

需要接收訊息的會話識別碼

options

ServiceBusSessionReceiverOptions

選項包括 receiveMode (預設為 peekLock) 、建立會話接收器的選項。

傳回

Promise<ServiceBusSessionReceiver>

可用來接收、查看和結算訊息的接收者。

close()

關閉基礎 AMQP 連線。 注意：這也會中斷從這個實例建立的任何接收者或傳送者實例的連線。

function close(): Promise<void>

傳回

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

建立Azure 服務匯流排佇列的接收者。 在呼叫接收者上的其中一個方法之前，不會連線到服務。

若要以寄不出的信件佇列或傳送寄不出的信件佇列之類的子佇列為目標，請在 選項中提供 subQueue 。 若要深入瞭解無效信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

未在鎖定期間內結算的訊息，將會重新傳遞佇列上設定的傳遞計數上限次數，之後才會傳送至個別的寄不出的信件佇列。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

參數

queueName

string

要接收的佇列名稱。

options

ServiceBusReceiverOptions

傳遞 receiveMode 的選項，預設為 peekLock。

傳回

ServiceBusReceiver

可用來接收、查看和結算訊息的接收者。

createReceiver(string, string, ServiceBusReceiverOptions)

建立Azure 服務匯流排訂閱的接收者。 在呼叫接收者上的其中一個方法之前，不會連線到服務。

若要以寄不出的信件佇列或傳送寄不出的信件佇列之類的子佇列為目標，請在 選項中提供 subQueue 。 若要深入瞭解無效信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

您可以選擇兩種接收模式：「peekLock」 (預設) 和 「receiveAndDelete」。

• 在 peekLock 模式中，接收者在佇列上指定的持續時間內鎖定訊息。
• 在 receiveAndDelete 模式中，訊息會在收到時從服務匯流排中刪除。

未在鎖定期間內結算的訊息，將會重新傳遞訂用帳戶上設定的傳遞計數上限次數，之後才會傳送至個別的寄不出的信件佇列。

您可以在接收者上呼叫 completeMessage () 、abandonMessage () 、deferMessage () 或 deadletterMessage () 方法來解決訊息。

如需 peekLock 和訊息結算如何運作的詳細資訊，請參閱： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

參數

topicName

string

我們想要接收之訂用帳戶的主題名稱。

subscriptionName

string

我們想要接收之) 下的 topic 訂用帳戶名稱 (。

options

ServiceBusReceiverOptions

傳遞 receiveMode 的選項，預設為 peekLock。

傳回

ServiceBusReceiver

可用來接收、查看和結算訊息的接收者。

createRuleManager(string, string)

建立用來管理訂用帳戶規則的 ServiceBusRuleManager 實例。

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

參數

topicName

string

建立ServiceBusRuleManager的主題

subscriptionName

string

要為其建立 ServiceBusRuleManager 之指定主題專屬的訂用帳戶。

傳回

ServiceBusRuleManager

ServiceBusRuleManager的範圍設定為指定的訂用帳戶和主題。

createSender(string, ServiceBusSenderOptions)

建立可用來傳送訊息的寄件者、排程稍後要傳送的訊息，以及取消這類排程的郵件。 在呼叫傳送者上的其中一個方法之前，不會與服務建立任何連線。

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

參數

queueOrTopicName

string

要傳送訊息的佇列或主題名稱。

options

ServiceBusSenderOptions

傳回

ServiceBusSender