ServiceBusReceiverOptions interface
Optionen, die beim Erstellen eines Empfängers verwendet werden sollen.
Eigenschaften
identifier | Legt den Namen fest, um den Empfänger zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird eine zufällige eindeutige verwendet. |
max |
Die maximale Dauer in Millisekunden, für die die Sperre der Nachricht automatisch vom Client verlängert wird. Diese automatische Verlängerung wird beendet, sobald die Nachricht abgeschlossen ist.
Beispiel: Wenn die Nachrichtensperre in 2 Minuten abläuft und Ihre Nachrichtenverarbeitungszeit 8 Minuten beträgt... Legen Sie maxAutoLockRenewalDurationInMs auf 10 Minuten fest, und die Nachrichtensperre wird automatisch für vier Mal verlängert (entspricht der 4-fachen Sperrdauer der Nachricht unter Verwendung der Sperrverlängerungen). |
receive |
Stellt den Empfangsmodus für den Empfänger dar. Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, sobald sie empfangen werden. Im peekLock-Modus verfügt der Empfänger über eine Sperre für die Nachricht für die für die Warteschlange/das Abonnement angegebene Dauer. Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange/das Abonnement festgelegte maximale Anzahl von Zustellungen erneut zugestellt, danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet. Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen. Weitere Informationen zur Funktionsweise von peekLock und der Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
skip |
Gibt an, ob die Konvertierung des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfang der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden Eigenschaften des Typs Date aus Kompatibilitätsgründen in die UNIX-Epochennummer konvertiert. |
skip |
Option zum Deaktivieren der Ausführung von JSON.parse() auf dem Client im Nachrichtentext, wenn die Nachricht empfangen wird. Gilt nicht, wenn die Nachricht mit dem WERT oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den im Nachrichtentext vorhandenen Bytes zu arbeiten, als der Client versucht, sie zu analysieren. |
sub |
Stellt die Untergeordnete Warteschlange dar, die für jede Warteschlange oder ein Abonnement gilt. Gültige Werte sind "deadLetter" und "transferDeadLetter". Weitere Informationen zu Warteschlangen für unzustellbare Nachrichten finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues |
Details zur Eigenschaft
identifier
Legt den Namen fest, um den Empfänger zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. Wenn nicht angegeben oder leer, wird eine zufällige eindeutige verwendet.
identifier?: string
Eigenschaftswert
string
maxAutoLockRenewalDurationInMs
Die maximale Dauer in Millisekunden, für die die Sperre der Nachricht automatisch vom Client verlängert wird. Diese automatische Verlängerung wird beendet, sobald die Nachricht abgeschlossen ist.
-
Standard:
300 * 1000
Millisekunden (5 Minuten). -
Um die Verlängerung des automatischen Sperrens zu deaktivieren, legen Sie dies auf fest
0
.
Beispiel:
Wenn die Nachrichtensperre in 2 Minuten abläuft und Ihre Nachrichtenverarbeitungszeit 8 Minuten beträgt...
Legen Sie maxAutoLockRenewalDurationInMs auf 10 Minuten fest, und die Nachrichtensperre wird automatisch für vier Mal verlängert (entspricht der 4-fachen Sperrdauer der Nachricht unter Verwendung der Sperrverlängerungen).
maxAutoLockRenewalDurationInMs?: number
Eigenschaftswert
number
receiveMode
Stellt den Empfangsmodus für den Empfänger dar.
Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, sobald sie empfangen werden.
Im peekLock-Modus verfügt der Empfänger über eine Sperre für die Nachricht für die für die Warteschlange/das Abonnement angegebene Dauer.
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange/das Abonnement festgelegte maximale Anzahl von Zustellungen erneut zugestellt, danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet.
Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und der Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
receiveMode?: "peekLock" | "receiveAndDelete"
Eigenschaftswert
"peekLock" | "receiveAndDelete"
skipConvertingDate
Gibt an, ob die Konvertierung des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfang der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden Eigenschaften des Typs Date aus Kompatibilitätsgründen in die UNIX-Epochennummer konvertiert.
skipConvertingDate?: boolean
Eigenschaftswert
boolean
skipParsingBodyAsJson
Option zum Deaktivieren der Ausführung von JSON.parse() auf dem Client im Nachrichtentext, wenn die Nachricht empfangen wird. Gilt nicht, wenn die Nachricht mit dem WERT oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den im Nachrichtentext vorhandenen Bytes zu arbeiten, als der Client versucht, sie zu analysieren.
skipParsingBodyAsJson?: boolean
Eigenschaftswert
boolean
subQueueType
Stellt die Untergeordnete Warteschlange dar, die für jede Warteschlange oder ein Abonnement gilt. Gültige Werte sind "deadLetter" und "transferDeadLetter". Weitere Informationen zu Warteschlangen für unzustellbare Nachrichten finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"
Eigenschaftswert
"deadLetter" | "transferDeadLetter"