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 sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert verwendet. |
| max |
Die maximale Dauer in Millisekunden, dass die Sperre für die Nachricht automatisch vom Client verlängert wird. Diese automatische Verlängerung wird beendet, sobald die Nachricht abgeschlossen wurde.
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 4 Mal automatisch erneuert (entspricht der 4-fachen Sperrdauer der Nachricht durch Nutzung der Sperrverlängerungen). |
| receive |
Stellt den Empfangsmodus für den Empfänger dar. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Im PeekLock-Modus verfügt der Empfänger über eine Sperre der Nachricht für die in der Warteschlange/dem Abonnement angegebene Dauer. Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die maximale Anzahl der Zustellungen in der Warteschlange/im Abonnement zurückgesetzt, nach der sie an eine separate Warteschlange für inaktive Briefe gesendet werden. Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| skip |
Gibt an, ob das Konvertieren des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfangen der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden die Eigenschaften des Typs Date aus Kompatibilitätsgründen in UNIX-Epochennummer konvertiert. |
| skip |
Option zum Deaktivieren des Clients beim Empfang der Nachricht vom Ausführen von JSON.parse() im Nachrichtentext. Nicht zutreffend, wenn die Nachricht mit DEM AMQP-Texttypwert oder -sequenz gesendet wurde. Verwenden Sie diese Option, wenn Sie lieber direkt mit den Im Nachrichtentext vorhandenen Bytes arbeiten möchten, als dass der Client versucht, sie zu analysieren. |
| sub |
Stellt die Unterwarteschlange dar, die für jede Warteschlange oder ein Abonnement gilt. Gültige Werte sind "deadLetter" und "transferDeadLetter". Weitere Informationen zu Warteschlangen mit toten Buchstaben 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 sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert verwendet.
identifier?: string
Eigenschaftswert
string
maxAutoLockRenewalDurationInMs
Die maximale Dauer in Millisekunden, dass die Sperre für die Nachricht automatisch vom Client verlängert wird. Diese automatische Verlängerung wird beendet, sobald die Nachricht abgeschlossen wurde.
-
Standard-:
300 * 1000Millisekunden (5 Minuten). -
Wenn Sie die Verlängerung der automatischen Sperredeaktivieren möchten, legen Sie dies auf
0fest.
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 4 Mal automatisch erneuert (entspricht der 4-fachen Sperrdauer der Nachricht durch Nutzung der Sperrverlängerungen).
maxAutoLockRenewalDurationInMs?: number
Eigenschaftswert
number
receiveMode
Stellt den Empfangsmodus für den Empfänger dar.
Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.
Im PeekLock-Modus verfügt der Empfänger über eine Sperre der Nachricht für die in der Warteschlange/dem Abonnement angegebene Dauer.
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die maximale Anzahl der Zustellungen in der Warteschlange/im Abonnement zurückgesetzt, nach der sie an eine separate Warteschlange für inaktive Briefe gesendet werden.
Sie können eine Nachricht begleichen, indem Sie die Methoden complete(), abandon(), defer() oder deadletter() für die Nachricht aufrufen.
Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
receiveMode?: "peekLock" | "receiveAndDelete"
Eigenschaftswert
"peekLock" | "receiveAndDelete"
skipConvertingDate
Gibt an, ob das Konvertieren des Datumstyps für Eigenschaften von Nachrichtenanmerkungen oder Anwendungseigenschaften beim Empfangen der Nachricht in Zahlen übersprungen werden soll. Standardmäßig werden die Eigenschaften des Typs Date aus Kompatibilitätsgründen in UNIX-Epochennummer konvertiert.
skipConvertingDate?: boolean
Eigenschaftswert
boolean
skipParsingBodyAsJson
Option zum Deaktivieren des Clients beim Empfang der Nachricht vom Ausführen von JSON.parse() im Nachrichtentext. Nicht zutreffend, wenn die Nachricht mit DEM AMQP-Texttypwert oder -sequenz gesendet wurde. Verwenden Sie diese Option, wenn Sie lieber direkt mit den Im Nachrichtentext vorhandenen Bytes arbeiten möchten, als dass der Client versucht, sie zu analysieren.
skipParsingBodyAsJson?: boolean
Eigenschaftswert
boolean
subQueueType
Stellt die Unterwarteschlange dar, die für jede Warteschlange oder ein Abonnement gilt. Gültige Werte sind "deadLetter" und "transferDeadLetter". Weitere Informationen zu Warteschlangen mit toten Buchstaben finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"
Eigenschaftswert
"deadLetter" | "transferDeadLetter"