ServiceBusReceiverOptions interface

패키지:

@azure/service-bus

수신기를 만들 때 사용할 옵션입니다.

속성

identifier	수신기를 식별할 이름을 설정합니다. 로그와 예외의 상관 관계를 지정하는 데 사용할 수 있습니다. 지정하거나 비워 두지 않으면 임의의 고유 항목이 사용됩니다.
maxAutoLockRenewalDurationInMs	메시지 잠금이 클라이언트에 의해 자동으로 갱신되는 최대 기간(밀리초)입니다. 이 자동 갱신은 메시지가 해결되면 중지됩니다. 기본: 300 * 1000 밀리초(5분)입니다. 자동 잠금 갱신사용하지 않도록 설정하려면 0설정합니다. 예제: 메시지 잠금이 2분 후에 만료되고 메시지 처리 시간이 8분인 경우... maxAutoLockRenewalDurationInMs를 10분으로 설정하면 메시지 잠금이 4번 자동으로 갱신됩니다(잠금 갱신을 활용하여 메시지가 잠금 기간의 4배에 대해 잠긴 것과 동일).
receiveMode	수신자의 수신 모드를 나타냅니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. peekLock 모드에서 수신자가 큐/구독에 지정된 기간 동안 메시지에 대한 잠금을 둡니다. 잠금 기간 내에 정해지지 않은 메시지는 큐/구독에 설정된 최대 배달 횟수의 2배만큼 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다. 메시지에서 complete(), abandon(), defer() 또는 deadletter() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 해결이 작동하는 방법에 대한 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	메시지를 받을 때 메시지 주석 또는 애플리케이션 속성의 속성에 대한 날짜 형식 변환을 건너뛸지 여부입니다. 기본적으로 Date 유형의 속성은 호환성을 위해 UNIX epoch 번호로 변환됩니다.
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

수신자의 수신 모드를 나타냅니다.

receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

peekLock 모드에서 수신자가 큐/구독에 지정된 기간 동안 메시지에 대한 잠금을 둡니다.

잠금 기간 내에 정해지지 않은 메시지는 큐/구독에 설정된 최대 배달 횟수의 2배만큼 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다.

메시지에서 complete(), abandon(), defer() 또는 deadletter() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 해결이 작동하는 방법에 대한 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

속성 값

"peekLock" | "receiveAndDelete"

skipConvertingDate

메시지를 받을 때 메시지 주석 또는 애플리케이션 속성의 속성에 대한 날짜 형식 변환을 건너뛸지 여부입니다. 기본적으로 Date 유형의 속성은 호환성을 위해 UNIX epoch 번호로 변환됩니다.

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"