ServiceBusReceiver interface

패키지:

@azure/service-bus

세션을 처리하지 않는 수신기입니다.

속성

entityPath	수신기가 만들어진 엔터티의 경로입니다.
identifier	수신기를 식별하는 데 사용되는 이름입니다. 로그와 예외의 상관 관계를 지정하는 데 사용할 수 있습니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.
isClosed	수신기 또는 수신기를 만든 클라이언트가 닫힌 경우 를 반환 true 합니다.
receiveMode	수신기를 만드는 데 사용되는 수신 모드입니다.

메서드

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	수신자가 메시지에 보관한 잠금이 해제되어 다른 수신 작업을 위해 Service Bus에서 메시지를 다시 사용할 수 있습니다.
close()	수신기를 닫습니다. 닫힌 후에는 수신기를 더 이상 작업에 사용할 수 없습니다. createReceiver() ServiceBusClient에서 메서드를 사용하여 새 수신기를 만듭니다.
completeMessage(ServiceBusReceivedMessage)	Service Bus에서 메시지를 제거합니다.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	메시지를 배달 못 한 하위 큐로 이동합니다. 배달 못한 메시지를 받으려면 데드렛 하위 큐의 경로를 사용하여 새 QueueClient/SubscriptionClient를 만듭니다.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	메시지 처리를 연기합니다. 나중에 메서드를 sequenceNumber 사용하여 메시지를 다시 받으려면 메시지의 를 receiveDeferredMessage 저장합니다.
getMessageIterator(GetMessageIteratorOptions)	Service Bus에서 메시지를 받는 데 사용할 수 있는 반복기를 반환합니다.
peekMessages(number, PeekMessagesOptions)	큐 또는 구독에서 활성 메시지의 다음 일괄 처리(지연되었지만 배달 못한 메시지 포함)를 수정하지 않고 피킹합니다. 에 대한 peekMessages() 첫 번째 호출은 첫 번째 활성 메시지를 가져옵니다. 각 후속 호출은 후속 메시지를 가져옵니다. "받은" 메시지와 달리 "피킹된" 메시지는 메시지의 읽기 전용 버전입니다. Completed/Abandoned/Deferred/Deadlettered일 수 없습니다.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	지정된 sequenceNumbers로 식별된 지연된 메시지 배열로 확인되는 프라미스를 반환합니다.
receiveMessages(number, ReceiveMessagesOptions)	Service Bus에서 받은 메시지 배열로 확인되는 프라미스를 반환합니다.
renewMessageLock(ServiceBusReceivedMessage)	큐/구독을 만드는 동안 지정된 기간 동안 메시지의 잠금을 갱신합니다. 잠금이 lockedUntilUtc 만료되는 시간에 대한 메시지의 속성을 확인합니다. 메시지가 고정되지 않은 경우(잠금이 만료되기 전에 , defer() 또는 deadletter()을 사용하여complete()) 메시지가 다음 수신 작업을 위해 큐/구독에 다시 배치됩니다.
subscribe(MessageHandlers, SubscribeOptions)	메시지를 메시지 처리기로 스트리밍합니다.

속성 세부 정보

entityPath

수신기가 만들어진 엔터티의 경로입니다.

entityPath: string

속성 값

string

identifier

수신기를 식별하는 데 사용되는 이름입니다. 로그와 예외의 상관 관계를 지정하는 데 사용할 수 있습니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

identifier: string

속성 값

string

isClosed

수신기 또는 수신기를 만든 클라이언트가 닫힌 경우 를 반환 true 합니다.

isClosed: boolean

속성 값

boolean

receiveMode

수신기를 만드는 데 사용되는 수신 모드입니다.

receiveMode: "peekLock" | "receiveAndDelete"

속성 값

"peekLock" | "receiveAndDelete"

메서드 세부 정보

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

수신자가 메시지에 보관한 잠금이 해제되어 다른 수신 작업을 위해 Service Bus에서 메시지를 다시 사용할 수 있습니다.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

메시지를 중단하는 동안 수정할 메시지의 속성입니다.

반환

Promise<void>

close()

수신기를 닫습니다. 닫힌 후에는 수신기를 더 이상 작업에 사용할 수 없습니다. createReceiver() ServiceBusClient에서 메서드를 사용하여 새 수신기를 만듭니다.

function close(): Promise<void>

반환

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Service Bus에서 메시지를 제거합니다.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

매개 변수

message

ServiceBusReceivedMessage

반환

Promise<void>

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

메시지를 배달 못 한 하위 큐로 이동합니다. 배달 못한 메시지를 받으려면 데드렛 하위 큐의 경로를 사용하여 새 QueueClient/SubscriptionClient를 만듭니다.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

메시지를 거부하는 동안 제공할 수 있는 DeadLetter 옵션입니다.

반환

Promise<void>

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

메시지 처리를 연기합니다. 나중에 메서드를 sequenceNumber 사용하여 메시지를 다시 받으려면 메시지의 를 receiveDeferredMessage 저장합니다.

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

매개 변수

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

메시지를 지연하는 동안 수정할 메시지의 속성입니다.

반환

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Service Bus에서 메시지를 받는 데 사용할 수 있는 반복기를 반환합니다.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

매개 변수

options

GetMessageIteratorOptions

수신 작업을 제어하는 옵션 집합입니다.

• abortSignal: 진행 중인 작업을 중단하는 데 사용할 신호입니다.

반환

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

큐 또는 구독에서 활성 메시지의 다음 일괄 처리(지연되었지만 배달 못한 메시지 포함)를 수정하지 않고 피킹합니다.

• 에 대한 peekMessages() 첫 번째 호출은 첫 번째 활성 메시지를 가져옵니다. 각 후속 호출은 후속 메시지를 가져옵니다.
• "받은" 메시지와 달리 "피킹된" 메시지는 메시지의 읽기 전용 버전입니다. Completed/Abandoned/Deferred/Deadlettered일 수 없습니다.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

매개 변수

maxMessageCount

number

피킹할 최대 메시지 수입니다.

options

PeekMessagesOptions

피킹할 최대 메시지 수, 피킹을 시작할 sequenceNumber 또는 작업을 중단하기 위한 abortSignal을 지정할 수 있는 옵션입니다.

반환

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

지정된 sequenceNumbers로 식별된 지연된 메시지 배열로 확인되는 프라미스를 반환합니다.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

매개 변수

sequenceNumbers

Long | Long[]

수신해야 하는 메시지에 대한 시퀀스 번호 또는 시퀀스 번호 배열입니다.

options

OperationOptionsBase

중단 신호 또는 추적 옵션을 전달하는 옵션 모음입니다.

반환

Promise<ServiceBusReceivedMessage[]>

지정된 시퀀스Numbers로 식별된 메시지 목록 또는 메시지가 없는 경우 빈 목록입니다.

receiveMessages(number, ReceiveMessagesOptions)

Service Bus에서 받은 메시지 배열로 확인되는 프라미스를 반환합니다.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

매개 변수

maxMessageCount

number

받을 최대 메시지 수입니다.

options

ReceiveMessagesOptions

수신 작업을 제어하는 옵션 집합입니다.

• maxWaitTimeInMs: 사용할 수 있는 메시지가 없는 경우 빈 배열을 반환하기 전에 첫 번째 메시지를 기다리는 최대 시간입니다.
• abortSignal: 진행 중인 작업을 중단하는 데 사용할 신호입니다.

반환

Promise<ServiceBusReceivedMessage[]>

메시지 배열로 해결되는 약속입니다.

renewMessageLock(ServiceBusReceivedMessage)

큐/구독을 만드는 동안 지정된 기간 동안 메시지의 잠금을 갱신합니다.

• 잠금이 lockedUntilUtc 만료되는 시간에 대한 메시지의 속성을 확인합니다.
• 메시지가 고정되지 않은 경우(잠금이 만료되기 전에 , defer() 또는 deadletter()을 사용하여complete()) 메시지가 다음 수신 작업을 위해 큐/구독에 다시 배치됩니다.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

매개 변수

message

ServiceBusReceivedMessage

반환

Promise<Date>

UTC 형식의 새 잠금 토큰 만료 날짜 및 시간입니다.

subscribe(MessageHandlers, SubscribeOptions)

메시지를 메시지 처리기로 스트리밍합니다.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

매개 변수

handlers

MessageHandlers

메시지 및 오류에 대해 호출되는 처리기입니다.

options

SubscribeOptions

구독 옵션입니다.

반환

{ close() => Promise<void> }

닫을 수 있는 개체로, 나머지 메시지를 handlers 보내고 새 메시지의 도착을 중지합니다.