ServiceBusMessage interface

패키지:

@azure/service-bus

Service Bus로 보낼 메시지를 설명합니다.

속성

applicationProperties	사용자 지정 메시지 메타데이터에 사용할 수 있는 애플리케이션별 속성입니다.
body	전송해야 하거나 수신해야 하는 메시지 본문입니다. 메시지를 받는 애플리케이션이 이 SDK를 사용하지 않는 경우 언어 간 호환성을 높이기 위해 본문 페이로드를 바이트 배열 또는 버퍼로 변환합니다.
contentType	메시지의 콘텐츠 형식입니다. 필요에 따라 RFC2045, 섹션 5의 형식(예: "application/json")에 따라 설명자를 사용하여 메시지의 페이로드를 설명합니다.
correlationId	애플리케이션이 메시지의 컨텍스트를 상관 관계 목적으로 지정할 수 있도록 하는 상관 관계 식별자입니다(예: 회신되는 메시지의 MessageId 반영). 메시지 라우팅 및 상관 관계를 참조하세요.
messageId	메시지 식별자는 메시지 및 해당 페이로드를 고유하게 식별하는 애플리케이션 정의 값입니다. 참고: 정수가 아닌 숫자는 허용되지 않습니다.
partitionKey	분할된 엔터티에 메시지를 보내기 위한 파티션 키입니다. 최대 길이는 128자입니다. 분할된 엔터티의 경우 이 값을 설정하면 관련 메시지가 동일한 내부 파티션에 할당되므로 전송 시퀀스 순서가 올바르게 기록됩니다. 파티션은 이 값에 대한 해시 함수에 의해 선택되며 직접 선택할 수 없습니다. 세션 인식 엔터티의 경우 속성이 sessionId 이 값을 재정의합니다. 분할되지 않은 엔터티의 경우 파티션 키는 무시됩니다.
replyTo	회신을 보낼 엔터티의 주소입니다. 이 선택적인 애플리케이션 정의 값은 메시지의 수신자에 대한 회신 경로를 나타내는 표준 방법입니다. 보낸 사람이 회신을 기대할 경우 해당 값을 회신이 전송될 큐 또는 토픽의 절대 또는 상대 경로로 설정합니다. 메시지 라우팅 및 상관 관계를 참조하세요.
replyToSessionId	주소를 보강하는 세션 식별자입니다 replyTo . 최대 길이는 128자입니다. 이 값은 ReplyTo 정보를 확대하며 회신 엔터티로 전송될 때 회신에 대해 설정해야 하는 SessionId를 지정합니다. 메시지 라우팅 및 상관 관계를 참조하세요.
scheduledEnqueueTimeUtc	메시지를 큐에 포함할 날짜 및 시간(UTC)입니다. 이 속성은 시간을 UTC로 반환합니다. 속성을 설정할 때 제공된 DateTime 값도 UTC여야 합니다. 이 값은 지연된 메시지 전송에 대한 값입니다. 나중에 특정 시간으로 보내는 메시지를 지연하는 데 사용됩니다. 메시지를 큐에 들이는 시간이 메시지를 동시에 전송한다는 의미는 아닙니다. 큐에 넣기는 하지만 실제 전송 시간은 큐의 워크로드 및 상태에 따라 달라집니다.
sessionId	세션 인식 엔터티에 대한 세션 식별자입니다. 최대 길이는 128자입니다. 세션 인식 엔터티의 경우 이 애플리케이션 정의 값은 메시지의 세션 정보를 지정합니다. 동일한 세션 식별자를 갖는 메시지는 요약 잠금이 적용되며 정확한 순차적 처리 및 역 멀티플렉싱이 지원됩니다. 세션 비인식 엔터티의 경우 이 값은 무시됩니다. 메시지 세션.
subject	애플리케이션별 레이블입니다. 이 속성을 사용하면 애플리케이션이 표준화된 수신자에게 메시지의 용도를 나타낼 수 있습니다. 패션, 전자 메일 제목 줄과 유사합니다. 매핑된 AMQP 속성은 "subject"입니다.
timeToLive	메시지의 TTL(Time To Live) 값입니다. 이 값은 메시지가 만료된 후의 상대 기간으로, 에 캡처된 대로 브로커가 메시지를 수락하고 저장한 즉시부터 시작합니다 enqueuedTimeUtc. 명시적으로 설정되지 않은 경우 예상되는 값은 해당 큐 또는 토픽에 대해 DefaultTimeToLive입니다. 메시지 수준 timeToLive 값은 엔터티의 DefaultTimeToLive 설정보다 길 수 없으며 자동으로 조정됩니다. 만료를 참조하세요.
to	"to" 주소입니다. 이 속성은 라우팅 시나리오에서 나중에 사용하기 위해 예약되어 있으며 현재 브로커 자체에서 무시됩니다. 애플리케이션은 규칙 기반 자동 전달 체인 시나리오에서 이 값을 사용하여 메시지의 의도된 논리적 대상을 나타낼 수 있습니다.

속성 세부 정보

applicationProperties

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

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

속성 값

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

body

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

body: any

속성 값

any

contentType

메시지의 콘텐츠 형식입니다. 필요에 따라 RFC2045, 섹션 5의 형식(예: "application/json")에 따라 설명자를 사용하여 메시지의 페이로드를 설명합니다.

contentType?: string

속성 값

string

correlationId

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

correlationId?: string | number | Buffer

속성 값

string | number | Buffer

messageId

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

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

messageId?: string | number | Buffer

속성 값

string | number | Buffer

partitionKey

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

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

partitionKey?: string

속성 값

string

replyTo

회신을 보낼 엔터티의 주소입니다. 이 선택적인 애플리케이션 정의 값은 메시지의 수신자에 대한 회신 경로를 나타내는 표준 방법입니다. 보낸 사람이 회신을 기대할 경우 해당 값을 회신이 전송될 큐 또는 토픽의 절대 또는 상대 경로로 설정합니다. 메시지 라우팅 및 상관 관계를 참조하세요.

replyTo?: string

속성 값

string

replyToSessionId

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

replyToSessionId?: string

속성 값

string

scheduledEnqueueTimeUtc

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

scheduledEnqueueTimeUtc?: Date

속성 값

Date

sessionId

세션 인식 엔터티에 대한 세션 식별자입니다. 최대 길이는 128자입니다. 세션 인식 엔터티의 경우 이 애플리케이션 정의 값은 메시지의 세션 정보를 지정합니다. 동일한 세션 식별자를 갖는 메시지는 요약 잠금이 적용되며 정확한 순차적 처리 및 역 멀티플렉싱이 지원됩니다. 세션 비인식 엔터티의 경우 이 값은 무시됩니다. 메시지 세션.

sessionId?: string

속성 값

string

subject

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

subject?: string

속성 값

string

timeToLive

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

timeToLive?: number

속성 값

number

to

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

to?: string

속성 값

string