ServiceBusReceiverOptions interface

Pacote:

@azure/service-bus

Opções a utilizar ao criar um recetor.

Propriedades

identifier	Define o nome para identificar o recetor. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou estiver vazio, será utilizado um exclusivo aleatório.
maxAutoLockRenewalDurationInMs	A duração máxima, em milissegundos, de que o bloqueio na mensagem será renovado automaticamente pelo cliente. Esta renovação automática para assim que a mensagem for resolvida. Predefinição: 300 * 1000 milissegundos (5 minutos). Para desativar a renovação automática, defina esta opção como 0. Exemplo: Se o bloqueio da mensagem expirar dentro de 2 minutos e o tempo de processamento da mensagem for de 8 minutos... Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio da mensagem será automaticamente renovado por 4 vezes (o equivalente a ter a mensagem bloqueada durante 4 vezes a duração do bloqueio ao tirar partido das renovações de bloqueio).
receiveMode	Representa o modo de receção do recetor. No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas. No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila/subscrição. As mensagens que não forem resolvidas dentro da duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na fila/subscrição, após a qual são enviadas para uma fila de mensagens não entregues separada. Pode resolver uma mensagem ao chamar métodos complete(), abandon(), defer() ou deadletter() na mensagem. Mais informações sobre como o peekLock e a resolução de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Se pretende ignorar a conversão do Tipo de data em propriedades de anotações de mensagens ou propriedades da aplicação em números ao receber a mensagem. Por predefinição, as propriedades do Tipo de data são convertidas em número de época UNIX para compatibilidade.
skipParsingBodyAsJson	Opção para desativar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem tiver sido enviada com o valor ou sequência do tipo de corpo AMQP. Utilize esta opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que se o cliente tentar analisá-la.
subQueueType	Representa a sub-fila que é aplicável a qualquer fila ou subscrição. Os valores válidos são "deadLetter" e "transferDeadLetter". Para saber mais sobre as filas de mensagens não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Detalhes de Propriedade

identifier

Define o nome para identificar o recetor. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou estiver vazio, será utilizado um exclusivo aleatório.

identifier?: string

Valor de Propriedade

string

maxAutoLockRenewalDurationInMs

A duração máxima, em milissegundos, de que o bloqueio na mensagem será renovado automaticamente pelo cliente. Esta renovação automática para assim que a mensagem for resolvida.

• Predefinição: 300 * 1000 milissegundos (5 minutos).
• Para desativar a renovação automática, defina esta opção como 0.

Exemplo:

Se o bloqueio da mensagem expirar dentro de 2 minutos e o tempo de processamento da mensagem for de 8 minutos...

Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio da mensagem será automaticamente renovado por 4 vezes (o equivalente a ter a mensagem bloqueada durante 4 vezes a duração do bloqueio ao tirar partido das renovações de bloqueio).

maxAutoLockRenewalDurationInMs?: number

Valor de Propriedade

number

receiveMode

Representa o modo de receção do recetor.

No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila/subscrição.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na fila/subscrição, após a qual são enviadas para uma fila de mensagens não entregues separada.

Pode resolver uma mensagem ao chamar métodos complete(), abandon(), defer() ou deadletter() na mensagem.

Mais informações sobre como o peekLock e a resolução de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valor de Propriedade

"peekLock" | "receiveAndDelete"

skipConvertingDate

Se pretende ignorar a conversão do Tipo de data em propriedades de anotações de mensagens ou propriedades da aplicação em números ao receber a mensagem. Por predefinição, as propriedades do Tipo de data são convertidas em número de época UNIX para compatibilidade.

skipConvertingDate?: boolean

Valor de Propriedade

boolean

skipParsingBodyAsJson

Opção para desativar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem tiver sido enviada com o valor ou sequência do tipo de corpo AMQP. Utilize esta opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que se o cliente tentar analisá-la.

skipParsingBodyAsJson?: boolean

Valor de Propriedade

boolean

subQueueType

Representa a sub-fila que é aplicável a qualquer fila ou subscrição. Os valores válidos são "deadLetter" e "transferDeadLetter". Para saber mais sobre as filas de mensagens não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Valor de Propriedade

"deadLetter" | "transferDeadLetter"