ServiceBusReceiverOptions interface

Пакет:

@azure/service-bus

Параметры, используемые при создании приемника.

Свойства

identifier	Задает имя для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или не указан, будет использоваться случайный уникальный.
maxAutoLockRenewalDurationInMs	Максимальная длительность в миллисекундах, которая будет обновляться клиентом автоматически. Это автоматическое продление останавливается после того, как сообщение будет решено. по умолчанию: 300 * 1000 миллисекунда (5 минут). Чтобы отключить автоматическое продление, установите для этого значение 0. Пример : Если срок действия блокировки сообщения истекает через 2 минуты, а время обработки сообщений — 8 минут... Установите значение maxAutoLockRenewalDurationInMs на 10 минут, и блокировка сообщения будет автоматически продлена в течение 4 раз (эквивалентно блокировке сообщения в течение 4 раз, используя продление блокировки).
receiveMode	Представляет режим получения для получателя. В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения. В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди или подписке. Сообщения, которые не урегулированы в течение длительности блокировки, будут повторно созданы столько раз, сколько максимальное число доставки в очереди или подписке, после чего они отправляются в отдельную очередь недоставленных писем. Вы можете урегулировать сообщение, вызвав методы complete(), abandon(), defer() или deadletter() в сообщении. Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Следует ли пропускать преобразование типа даты для свойств примечаний сообщения или свойств приложения в числа при получении сообщения. По умолчанию свойства типа Date преобразуются в номер эпохи UNIX для совместимости.
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

Представляет режим получения для получателя.

В режиме полученияAndDelete сообщения удаляются из служебной шины по мере их получения.

В режиме просмотраLock получатель имеет блокировку сообщения в течение длительности, указанной в очереди или подписке.

Сообщения, которые не урегулированы в течение длительности блокировки, будут повторно созданы столько раз, сколько максимальное число доставки в очереди или подписке, после чего они отправляются в отдельную очередь недоставленных писем.

Вы можете урегулировать сообщение, вызвав методы complete(), abandon(), defer() или deadletter() в сообщении.

Дополнительные сведения о том, как работает проверка блокировки и урегулирования сообщений здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Значение свойства

"peekLock" | "receiveAndDelete"

skipConvertingDate

Следует ли пропускать преобразование типа даты для свойств примечаний сообщения или свойств приложения в числа при получении сообщения. По умолчанию свойства типа Date преобразуются в номер эпохи UNIX для совместимости.

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"