ServiceBusReceiverOptions interface

套件:: @azure/service-bus

建立接收者時要使用的選項。

屬性

identifier	設定用來識別接收者的名稱。這可用來將記錄和例外狀況相互關聯。如果未指定或空白，則會使用隨機唯一的。
maxAutoLockRenewalDurationInMs	用戶端會自動更新訊息鎖定的最大持續時間，以毫秒為單位。此自動續約會在訊息解決後停止。預設：`300 * 1000` 毫秒（5 分鐘）。若要停用自動鎖定更新，請將此設定為 `0`。範例：如果訊息鎖定在 2 分鐘內過期，而您的訊息處理時間是 8 分鐘... 將 maxAutoLockRenewalDurationInMs 設定為 10 分鐘，而且訊息鎖定將自動更新 4 次（相當於利用鎖定更新將訊息鎖定 4 倍）。
receiveMode	表示接收者的接收模式。在 receiveAndDelete 模式中，訊息會在收到時從服務總線中刪除。在 peekLock 模式中，接收者在佇列/訂用帳戶上指定的持續時間內鎖定訊息。未在鎖定期間內解決的訊息，將會重新傳遞佇列/訂用帳戶上設定的最大傳遞計數次數，之後再傳送至個別的寄不出的信件佇列。您可以在訊息上呼叫 complete（）、abandon（）、defer（）或 deadletter（）方法來解決訊息。如需 peekLock 和訊息解決方式的詳細資訊，請參閱這裡：https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	是否要在接收訊息時略過將訊息批注的屬性或應用程式屬性上的 Date 類型轉換成數位。根據預設，Date 類型的屬性會轉換成 UNIX epoch 編號以取得相容性。
skipParsingBodyAsJson	在接收訊息時，停用用戶端在訊息本文上執行 JSON.parse（）的選項。如果訊息是以AMQP 本文類型值或序列傳送，則不適用。當您偏好直接處理訊息本文中存在的位元元組時，請使用此選項，而不是讓客戶端嘗試剖析它。
subQueueType	表示適用於任何佇列或訂用帳戶的子佇列。有效值為「deadLetter」和「transferDeadLetter」。若要深入瞭解寄不出的信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

屬性詳細資料

identifier

設定用來識別接收者的名稱。這可用來將記錄和例外狀況相互關聯。如果未指定或空白，則會使用隨機唯一的。

identifier?: string

屬性值

string

maxAutoLockRenewalDurationInMs

用戶端會自動更新訊息鎖定的最大持續時間，以毫秒為單位。此自動續約會在訊息解決後停止。

預設：300 * 1000 毫秒（5 分鐘）。
若要停用自動鎖定更新，請將此設定為 0。

範例：

如果訊息鎖定在 2 分鐘內過期，而您的訊息處理時間是 8 分鐘...

將 maxAutoLockRenewalDurationInMs 設定為 10 分鐘，而且訊息鎖定將自動更新 4 次（相當於利用鎖定更新將訊息鎖定 4 倍）。

maxAutoLockRenewalDurationInMs?: number

屬性值

number

receiveMode

表示接收者的接收模式。

在 receiveAndDelete 模式中，訊息會在收到時從服務總線中刪除。

在 peekLock 模式中，接收者在佇列/訂用帳戶上指定的持續時間內鎖定訊息。

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

您可以在訊息上呼叫 complete（）、abandon（）、defer（）或 deadletter（）方法來解決訊息。

如需 peekLock 和訊息解決方式的詳細資訊，請參閱這裡：https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

屬性值

"peekLock" | "receiveAndDelete"

skipConvertingDate

是否要在接收訊息時略過將訊息批注的屬性或應用程式屬性上的 Date 類型轉換成數位。根據預設，Date 類型的屬性會轉換成 UNIX epoch 編號以取得相容性。

skipConvertingDate?: boolean

屬性值

boolean

skipParsingBodyAsJson

在接收訊息時，停用用戶端在訊息本文上執行 JSON.parse（）的選項。如果訊息是以AMQP 本文類型值或序列傳送，則不適用。當您偏好直接處理訊息本文中存在的位元元組時，請使用此選項，而不是讓客戶端嘗試剖析它。

skipParsingBodyAsJson?: boolean

屬性值

boolean

subQueueType

表示適用於任何佇列或訂用帳戶的子佇列。有效值為「deadLetter」和「transferDeadLetter」。若要深入瞭解寄不出的信件佇列，請參閱 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

屬性值

"deadLetter" | "transferDeadLetter"

共用方式為