Delen via

ServiceBusReceiverOptions interface

  • Referentie
Pakket:
@azure/service-bus

Opties om te gebruiken bij het maken van een ontvanger.

Eigenschappen

identifier

Hiermee stelt u de naam in om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt een willekeurige unieke gebruikt.
maxAutoLockRenewalDurationInMs

De maximale duur, in milliseconden, dat de vergrendeling van het bericht automatisch wordt vernieuwd door de client. Deze automatische verlenging stopt zodra het bericht is vereffend.

  • Standaard: 300 * 1000 milliseconden (5 minuten).
  • Als u het verlengen van automatische vergrendeling wilt uitschakelen, stelt u dit in op 0.

Voorbeeld:

Als de berichtenvergrendeling over 2 minuten verloopt en de verwerkingstijd van uw bericht 8 minuten is...

Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de berichtvergrendeling wordt automatisch 4 keer vernieuwd (gelijk aan dat het bericht 4 keer de vergrendelingsduur heeft vergrendeld door gebruik te maken van de vergrendelingsvernieuwingen).
receiveMode

Vertegenwoordigt de ontvangstmodus voor de ontvanger.

In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus wanneer ze worden ontvangen.

In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij/het abonnement.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij/het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden.

U kunt een bericht vereffenen door de methoden complete(), abandon(), defer() of deadletter() voor het bericht aan te roepen.

Meer informatie over de werking van PeekLock en message settlement vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Of u het converteren van datumtype voor de eigenschappen van berichtannotaties of toepassingseigenschappen naar getallen wilt overslaan bij het ontvangen van het bericht. Eigenschappen van datumtype worden voor compatibiliteit standaard geconverteerd naar unix-epoch-getal.
skipParsingBodyAsJson

Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() op de berichttekst bij ontvangst van het bericht. Niet van toepassing als het bericht is verzonden met de waarde of volgorde van het AMQP-hoofdteksttype. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.
subQueueType

Vertegenwoordigt de subwachtrij die van toepassing is op een wachtrij of abonnement. Geldige waarden zijn 'deadLetter' en 'transferDeadLetter'. Zie voor meer informatie over wachtrijen met onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Eigenschapdetails

identifier

Hiermee stelt u de naam in om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt een willekeurige unieke gebruikt.

identifier?: string

Waarde van eigenschap

string

maxAutoLockRenewalDurationInMs

De maximale duur, in milliseconden, dat de vergrendeling van het bericht automatisch wordt vernieuwd door de client. Deze automatische verlenging stopt zodra het bericht is vereffend.

  • Standaard: 300 * 1000 milliseconden (5 minuten).
  • Als u het verlengen van automatische vergrendeling wilt uitschakelen, stelt u dit in op 0.

Voorbeeld:

Als de berichtenvergrendeling over 2 minuten verloopt en de verwerkingstijd van uw bericht 8 minuten is...

Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de berichtvergrendeling wordt automatisch 4 keer vernieuwd (gelijk aan dat het bericht 4 keer de vergrendelingsduur heeft vergrendeld door gebruik te maken van de vergrendelingsvernieuwingen).

maxAutoLockRenewalDurationInMs?: number

Waarde van eigenschap

number

receiveMode

Vertegenwoordigt de ontvangstmodus voor de ontvanger.

In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus wanneer ze worden ontvangen.

In de peekLock-modus heeft de ontvanger een vergrendeling op het bericht voor de duur die is opgegeven in de wachtrij/het abonnement.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw verzonden als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij/het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden.

U kunt een bericht vereffenen door de methoden complete(), abandon(), defer() of deadletter() voor het bericht aan te roepen.

Meer informatie over de werking van PeekLock en message settlement vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Waarde van eigenschap

"peekLock" | "receiveAndDelete"

skipConvertingDate

Of u het converteren van datumtype voor de eigenschappen van berichtannotaties of toepassingseigenschappen naar getallen wilt overslaan bij het ontvangen van het bericht. Eigenschappen van datumtype worden voor compatibiliteit standaard geconverteerd naar unix-epoch-getal.

skipConvertingDate?: boolean

Waarde van eigenschap

boolean

skipParsingBodyAsJson

Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() op de berichttekst bij ontvangst van het bericht. Niet van toepassing als het bericht is verzonden met de waarde of volgorde van het AMQP-hoofdteksttype. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.

skipParsingBodyAsJson?: boolean

Waarde van eigenschap

boolean

subQueueType

Vertegenwoordigt de subwachtrij die van toepassing is op een wachtrij of abonnement. Geldige waarden zijn 'deadLetter' en 'transferDeadLetter'. Zie voor meer informatie over wachtrijen met onbestelbare berichten https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Waarde van eigenschap

"deadLetter" | "transferDeadLetter"