ServiceBusReceivedMessage interface

메시지를 배달하지 못한 경우의 오류 설명입니다.

deadLetterErrorDescription?: string

속성 값

메시지를 배달하지 못한 이유입니다.

deadLetterReason?: string

속성 값

이 메시지가 배달 취소되기 전에 큐에 넣은 큐 또는 구독의 이름입니다. 배달 못 한 편지로 배달 못한 편지 하위 큐에서 다른 엔터티로 자동 전달된 메시지에서만 설정합니다. 메시지가 배달 못 한 엔터티를 나타냅니다.

deadLetterSource?: string

속성 값

이 메시지에 대해 시도된 배달 수입니다. 메시지 잠금이 만료되거나 메시지의 abandon() 메서드를 사용하여 메시지가 명시적으로 중단되면 개수가 증가합니다.

deliveryCount?: number

속성 값

메시지의 원래 시퀀스 번호입니다. 자동 전달된 메시지의 경우 이 속성은 원래 제출 지점에서 메시지에 처음 할당된 시퀀스 번호를 반영합니다.

enqueuedSequenceNumber?: number

속성 값

메시지가 수락되고 Service Bus에 저장된 UTC 인스턴트입니다.

enqueuedTimeUtc?: Date

속성 값

메시지가 제거되도록 표시되고 만료로 인해 엔터티에서 더 이상 검색할 수 없는 UTC 인스턴트입니다. 이 속성은 메시지의 다른 두 속성인 enqueuedTimeUtc + timeToLive계산됩니다.

expiresAtUtc?: Date

속성 값

메시지가 큐/구독에 잠겨 있는 UTC 인스턴트입니다. 잠금이 만료되면 deliveryCount 증가하며 메시지를 다시 검색할 수 있습니다.

• 메시지가 수신 모드에서 수신되는 receiveAndDelete 적용할 수 없습니다. 모드.

lockedUntilUtc?: Date

속성 값

잠금 토큰은 peekLock 수신 모드에서 broker가 보유하는 잠금에 대한 참조입니다. 잠금은 제품 설명서에 설명된 대로 내부적으로 메시지를 정산하는 데 사용됩니다

• 메시지가 수신 모드에서 수신되는 receiveAndDelete 적용할 수 없습니다. 모드.

lockToken?: string

속성 값

Service Bus에서 메시지에 할당된 고유 번호입니다. 시퀀스 번호는 broker에 의해 수락되고 저장되고 실제 식별자로 기능할 때 메시지에 할당된 고유한 64비트 정수입니다. 분할된 엔터티의 경우 가장 상위 16비트는 파티션 식별자를 반영합니다. 시퀀스 번호는 단조로 증가합니다. 48-64비트 범위가 소진되면 0으로 롤오버됩니다.

Javascript에서 현재 지원하는 최대 안전 정수2^53 - 1. 시퀀스 번호는 최대 64비트 길이일 수 있는 AMQP Long 형식입니다. long.js라이브러리를 사용하고 있음을 나타냅니다. 고객이 이 라이브러리에서 내보낸 Long 형식을 사용할 것으로 예상합니다.

sequenceNumber?: Long

속성 값

메시지의 상태는 활성, 지연 또는 예약될 수 있습니다. 지연된 메시지는 지연 상태, 예약된 메시지는 예약된 상태, 다른 모든 메시지는 활성 상태입니다.

state: "active" | "deferred" | "scheduled"

속성 값

사용자 지정 메시지 메타데이터에 사용할 수 있는 애플리케이션별 속성입니다.

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

속성 값

ServiceBusMessage.applicationProperties 상속된

보내거나 받아야 하는 메시지 본문입니다. 메시지를 수신하는 애플리케이션이 이 SDK를 사용하지 않는 경우 더 나은 언어 간 호환성을 위해 본문 페이로드를 바이트 배열 또는 버퍼로 변환합니다.

body: any

속성 값

ServiceBusMessage.body 상속된

메시지의 콘텐츠 형식입니다. 필요에 따라 메시지의 페이로드를 설명하며 설명자는 RFC2045 형식인 섹션 5(예: "application/json")를 따르세요.

contentType?: string

속성 값

ServiceBusMessage.contentType 상속된

애플리케이션에서 상관 관계 목적으로 메시지의 컨텍스트를 지정할 수 있도록 하는 상관 관계 식별자입니다(예: 회신되는 메시지의 MessageId 반영). 메시지 라우팅 및 상관 관계참조하세요.

correlationId?: string | number | Buffer

속성 값

ServiceBusMessage.correlationId 상속된

메시지 식별자는 메시지와 해당 페이로드를 고유하게 식별하는 애플리케이션 정의 값입니다.

참고: 정수가 아닌 숫자는 허용되지 않습니다.

messageId?: string | number | Buffer

속성 값

ServiceBusMessage.messageId 상속된

분할된 엔터티에 메시지를 보내기 위한 파티션 키입니다. 최대 길이는 128자입니다. 분할된 엔터티 경우 이 값을 설정하면 관련 메시지를 동일한 내부 파티션에 할당할 수 있으므로 제출 순서 순서가 올바르게 기록됩니다. 파티션은 이 값보다 해시 함수에 의해 선택되며 직접 선택할 수 없습니다.

• 세션 인식 엔터티의 경우 sessionId 속성이 이 값을 재정의합니다.
• 분할되지 않은 엔터티의 경우 파티션 키는 무시됩니다.

partitionKey?: string

속성 값

ServiceBusMessage.partitionKey 상속된

회신을 보낼 엔터티의 주소입니다. 이 선택적 및 애플리케이션 정의 값은 메시지 수신자의 회신 경로를 표현하는 표준 방법입니다. 보낸 사람에게 회신이 필요하면 회신이 전송될 것으로 예상되는 큐 또는 토픽의 절대 또는 상대 경로로 값을 설정합니다. 메시지 라우팅 및 상관 관계참조하세요.

replyTo?: string

속성 값

ServiceBusMessage.replyTo 상속된

replyTo 주소를 보강하는 세션 식별자입니다. 최대 길이는 128자입니다. 이 값은 ReplyTo 정보를 보강하고 회신 엔터티로 보낼 때 회신에 대해 설정해야 하는 SessionId를 지정합니다. 메시지 라우팅 및 상관 관계참조하세요.

replyToSessionId?: string

속성 값

ServiceBusMessage.replyToSessionId 상속됨

메시지를 큐에 포함할 날짜 및 시간(UTC)입니다. 이 속성은 UTC로 시간을 반환합니다. 속성을 설정할 때 제공된 DateTime 값도 UTC여야 합니다. 이 값은 지연된 메시지 전송에 대한 값입니다. 나중에 특정 시간으로 보내는 메시지를 지연하는 데 사용됩니다. 메시지를 큐에 보내는 시간이 메시지를 동시에 전송한다는 의미는 아닙니다. 큐에 들어가지만 실제 전송 시간은 큐의 워크로드 및 상태에 따라 달라집니다.

scheduledEnqueueTimeUtc?: Date

속성 값

ServiceBusMessage.scheduledEnqueueTimeUtc 상속된

세션 인식 엔터티의 세션 식별자입니다. 최대 길이는 128자입니다. 세션 인식 엔터티의 경우 이 애플리케이션 정의 값은 메시지의 세션 소속을 지정합니다. 세션 식별자가 동일한 메시지는 요약 잠금이 적용되며 정확한 순서 내 처리 및 삭제를 사용하도록 설정합니다. 세션을 인식하지 못하는 엔터티의 경우 이 값은 무시됩니다. 메시지 세션.

sessionId?: string

속성 값

ServiceBusMessage.sessionId 상속된

애플리케이션별 레이블입니다. 이 속성을 사용하면 애플리케이션이 표준화된 수신자에게 메시지의 용도를 나타낼 수 있습니다. 패션, 전자 메일 제목 줄과 유사합니다. 매핑된 AMQP 속성은 "subject"입니다.

subject?: string

속성 값

ServiceBusMessage.subject 상속된

메시지의 TL(Time to Live) 값입니다. 이 값은 메시지가 만료된 후의 상대 기간으로, enqueuedTimeUtc캡처된 것처럼 broker가 메시지를 수락하고 저장한 순간부터 시작합니다. 명시적으로 설정하지 않으면 가정된 값은 해당 큐 또는 토픽에 대한 DefaultTimeToLive입니다. 메시지 수준 timeToLive 값은 엔터티의 DefaultTimeToLive 설정보다 길 수 없으며 자동으로 조정됩니다. 만료참조하세요.

timeToLive?: number

속성 값

ServiceBusMessage.timeToLive 상속된

"to" 주소입니다. 이 속성은 라우팅 시나리오에서 나중에 사용하도록 예약되어 있으며 현재 broker 자체에서 무시됩니다. 애플리케이션은 규칙 기반 자동 전달 체인 시나리오에서 이 값을 사용하여 메시지의 의도된 논리적 대상을 나타낼 수 있습니다.

to?: string

속성 값

ServiceBusMessage.to 상속된