ServiceBusMessage 클래스

  • 참조

Service Bus 메시지입니다.

상속
builtins.object
ServiceBusMessage

생성자

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

매개 변수

body
Optional[Union[str, bytes]]
필수

단일 메시지로 보낼 데이터입니다.

application_properties
Dict[str, Union[int 또는 float 또는 bool 또는 bytes 또는 str 또는 UUID 또는 datetime 또는 None]]

메시지의 사용자 정의 속성입니다.

session_id
Optional[str]

세션 엔터티에 대한 메시지의 세션 식별자입니다.

message_id
Optional[str]

메시지를 식별할 ID입니다.

scheduled_enqueue_time_utc
Optional[datetime]

메시지에 대한 utc 예약 큐에 넣은 시간입니다.

time_to_live
Optional[timedelta]

메시지의 수명 기간입니다.

content_type
Optional[str]

콘텐츠 형식 설명자입니다.

correlation_id
Optional[str]

상관 관계 식별자입니다.

subject
Optional[str]

애플리케이션별 제목(레이블이라고도 함)입니다.

partition_key
Optional[str]

분할된 엔터티에 메시지를 보내기 위한 파티션 키입니다.

to
Optional[str]

auto_forward 체인 시나리오에 사용되는 주소입니다 .

reply_to
Optional[str]

회신을 보낼 엔터티의 주소입니다.

reply_to_session_id
Optional[str]

reply_to 주소를 보강하는 세션 식별자입니다.

예제

추가 속성이 포함된 메시지 보내기


   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

특성

application_properties

메시지의 사용자 정의 속성입니다.

반환 형식

dict[str,
bytes, <xref:PrimitiveTypes>],
None

body

메시지의 본문입니다. 형식은 본문 유형에 따라 다를 수 있습니다. 의 경우 DATA본문은 바이트 또는 반복 가능[바이트]일 수 있습니다. 의 경우 SEQUENCE본문은 List 또는 Iterable[List]일 수 있습니다. 의 경우 VALUE본문은 모든 형식일 수 있습니다.

반환 형식

Any

body_type

기본 AMQP 메시지의 본문 유형입니다.

반환 형식

AmqpMessageBodyType

content_type

콘텐츠 형식 설명자입니다.

필요에 따라 "application/json"과 같은 RFC2045 섹션 5 형식을 따르는 설명자를 사용하여 메시지의 페이로드를 설명합니다.

반환 형식

str,
None

correlation_id

상관 관계 식별자입니다.

애플리케이션이 상관 관계(예: 회신되는 메시지의 MessageId 반영)를 위해 메시지에 대한 컨텍스트를 지정할 수 있도록 합니다.

의 메시지 라우팅 및 상관 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation관계를 참조하세요.

반환 형식

str,
None

message

기본 uamqp를 가져옵니다. Message 또는 LegacyMessage. 이 기능은 더 이상 사용되지 않으며 이후 릴리스에서 제거됩니다.

반환 형식

<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

메시지를 식별할 ID입니다.

메시지 식별자는 메시지 및 해당 페이로드를 고유하게 식별하는 애플리케이션 정의 값입니다. 식별자는 자유 형식 문자열이고 애플리케이션 컨텍스트에서 파생된 GUID 또는 식별자를 반영할 수 있습니다. 사용하도록 설정된 경우 중복 검색(참조 https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) 기능은 동일한 메시지 ID를 가진 메시지의 두 번째 및 추가 제출을 식별하고 제거합니다.

반환 형식

str,
None

partition_key

분할된 엔터티에 메시지를 보내기 위한 파티션 키입니다.

이 값을 설정하면 제출 시퀀스 순서가 올바르게 기록되도록 관련 메시지를 동일한 내부 파티션에 할당할 수 있습니다. 파티션은 이 값에 대한 해시 함수에 의해 선택되며 직접 선택할 수 없습니다.

에서 분할된 큐 및 topics https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning참조하세요.

반환 형식

str,
None

raw_amqp_message

고급 사용량만. 전송되거나 수신되는 내부 AMQP 메시지 페이로드입니다. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

회신을 보낼 엔터티의 주소입니다.

이 선택적인 애플리케이션 정의 값은 메시지의 수신자에 대한 회신 경로를 나타내는 표준 방법입니다. 보낸 사람이 회신을 기대할 경우 해당 값을 회신이 전송될 큐 또는 토픽의 절대 또는 상대 경로로 설정합니다.

의 메시지 라우팅 및 상관 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation관계를 참조하세요.

반환 형식

str,
None

reply_to_session_id

reply_to 주소를 보강하는 세션 식별자입니다.

이 값은 reply_to 정보를 보강하고 회신 엔터티로 보낼 때 회신에 대해 설정해야 하는 세션 ID를 지정합니다.

의 메시지 라우팅 및 상관 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation관계를 참조하세요.

반환 형식

str,
None

scheduled_enqueue_time_utc

메시지에 대한 utc 예약 큐에 넣은 시간입니다.

이 속성은 ServiceBusSender.send 메서드를 통해 메시지를 보낼 때 예약하는 데 사용할 수 있습니다. 예약된 메시지를 취소해야 하는 경우 나중에 취소하는 데 사용할 수 있는 시퀀스 번호를 반환하는 ServiceBusSender.schedule 메서드를 사용해야 합니다. scheduled_enqueue_time_utc 설정되지 않은 경우 None입니다.

반환 형식

datetime

session_id

세션 엔터티에 대한 메시지의 세션 식별자입니다.

세션 엔터티의 경우 이 애플리케이션 정의 값은 메시지의 세션 소속을 지정합니다. 동일한 세션 식별자를 갖는 메시지는 요약 잠금이 적용되며 정확한 순차적 처리 및 역 멀티플렉싱이 지원됩니다. 세션이 아닌 엔터티의 경우 이 값은 무시됩니다.

의 메시지 세션을 https://docs.microsoft.com/azure/service-bus-messaging/message-sessions참조하세요.

반환 형식

str,
None

subject

애플리케이션 특정 제목(레이블이라고도 함).

이 속성을 사용하여 애플리케이션은 메시지 용도를 전자 메일 제목 줄과 비슷하게 표준화된 방식으로 나타낼 수 있습니다.

반환 형식

str

time_to_live

메시지의 수명 기간입니다.

이 값은 메시지가 만료된 이후의 상대 기간으로, 메시지가 수락되고 broker가 저장한 즉시부터 시작하여 enqueued_time_utc 캡처됩니다. 명시적으로 설정되지 않은 경우 예상되는 값은 해당 큐 또는 토픽에 대해 DefaultTimeToLive입니다. 메시지 수준 TL(time-to-Live) 값은 엔터티의 TL(time-to-Live) 설정보다 길 수 없으며, 이 경우 자동으로 조정됩니다.

의 만료를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

반환 형식

timedelta

to

주소를 지정하는 입니다.

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

자세한 내용은 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding를 참조하세요.

반환 형식

str,
None