Sdílet prostřednictvím

ServiceBusMessage Třída

  • Reference

Zpráva služby Service Bus.

Dědičnost
builtins.object
ServiceBusMessage

Konstruktor

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)

Parametry

body
Optional[Union[str, bytes]]
Vyžadováno

Data, která se mají odeslat v jedné zprávě.

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

Uživatelem definované vlastnosti zprávy.

session_id
Optional[str]

Identifikátor relace zprávy pro entitu s obsahem relace.

message_id
Optional[str]

ID pro identifikaci zprávy.

scheduled_enqueue_time_utc
Optional[datetime]

Čas zařazení zprávy do fronty naplánovaný ve formátu UTC.

time_to_live
Optional[timedelta]

Doba života zprávy.

content_type
Optional[str]

Popisovač typu obsahu.

correlation_id
Optional[str]

Identifikátor korelace.

subject
Optional[str]

Předmět specifický pro aplikaci, někdy označovaný jako label.

partition_key
Optional[str]

Klíč oddílu pro odeslání zprávy do dělené entity.

to
Optional[str]

Adresa , která se používá pro scénáře řetězení auto_forward.

reply_to
Optional[str]

Adresa entity, do které se mají posílat odpovědi.

reply_to_session_id
Optional[str]

Identifikátor relace rozšiřující reply_to adresu.

Příklady

Odeslání zprávy s dalšími vlastnostmi


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

Atributy

application_properties

Uživatelem definované vlastnosti zprávy.

Návratový typ

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

body

Text zprávy. Formát se může lišit v závislosti na typu textu: Pro DATAmůže být tělo bajty nebo iterable[bajty]. Text SEQUENCEmůže být List nebo Iterable[List]. V VALUEpřípadě může být tělo libovolného typu.

Návratový typ

Any

body_type

Typ textu podkladové zprávy AMQP.

Návratový typ

AmqpMessageBodyType

content_type

Popisovač typu obsahu.

Volitelně popisuje datovou část zprávy, přičemž popisovač následuje za formátem RFC2045, Oddíl 5, například application/json.

Návratový typ

str,
None

correlation_id

Identifikátor korelace.

Umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odrážet MessageId zprávy, na kterou odpovídáte.

Viz Směrování a korelace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návratový typ

str,
None

message

Získejte základní uamqp. Message nebo LegacyMessage. Tato možnost je zastaralá a v pozdější verzi se odebere.

Návratový typ

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

message_id

ID pro identifikaci zprávy.

Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část. Identifikátor je řetězec volného tvaru a může odrážet identifikátor GUID nebo identifikátor odvozený z kontextu aplikace. Pokud je tato funkce povolená, funkce zjišťování duplicit (viz https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifikuje a odebere druhé a další odeslání zpráv se stejným ID zprávy.

Návratový typ

str,
None

partition_key

Klíč oddílu pro odeslání zprávy do dělené entity.

Nastavení této hodnoty umožní přiřazovat související zprávy ke stejnému internímu oddílu, aby se pořadí pořadí odesílání správně zaznamenalo. Oddíl je zvolen funkcí hash nad touto hodnotou a nelze ho zvolit přímo.

Viz Dělené fronty a témata v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Návratový typ

str,
None

raw_amqp_message

Pouze rozšířené využití. Interní datová část zprávy AMQP, která je odeslána nebo přijata. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Adresa entity, do které se mají posílat odpovědi.

Tato volitelná a aplikace definovaná hodnota představuje standardní způsob, jak vyjádřit cestu odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu absolutní nebo relativní cesty k frontě nebo tématu, do které očekává odeslání odpovědi.

Viz Směrování a korelace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návratový typ

str,
None

reply_to_session_id

Identifikátor relace rozšiřující reply_to adresu.

Tato hodnota rozšiřuje reply_to informace a určuje, které ID relace se má nastavit pro odpověď při odeslání do entity odpovědi.

Viz Směrování a korelace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návratový typ

str,
None

scheduled_enqueue_time_utc

Čas zařazení zprávy do fronty naplánovaný ve formátu UTC.

Tuto vlastnost lze použít pro plánování při odesílání zprávy prostřednictvím metody ServiceBusSender.send . Pokud se vyžaduje zrušení naplánovaných zpráv, měli byste použít metodu ServiceBusSender.schedule , která vrací pořadová čísla, která lze použít pro budoucí zrušení. scheduled_enqueue_time_utc je Hodnota Žádná, pokud není nastavená.

Návratový typ

datetime

session_id

Identifikátor relace zprávy pro entitu s obsahem relace.

U entit s relacemi tato hodnota definovaná aplikací určuje přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému uzamčení a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nejsou určené relacemi, se tato hodnota ignoruje.

Viz Relace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Návratový typ

str,
None

subject

Předmět specifický pro aplikaci, někdy označovaný jako popisek.

Tato vlastnost umožňuje aplikaci označit účel zprávy příjemci standardizovaným způsobem, podobně jako řádek předmětu e-mailu.

Návratový typ

str

time_to_live

Doba života zprávy.

Tato hodnota je relativní doba trvání, po které zpráva vyprší, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachycena v enqueued_time_utc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota time-to-live na úrovni zprávy nemůže být delší než nastavení time-to-live entity, a pokud ano, upraví se tiše.

Viz Vypršení platnosti v https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Návratový typ

timedelta

to

Adresa příjemce .

Tato vlastnost je vyhrazena pro budoucí použití ve scénářích směrování a v současné době je ignorována samotným zprostředkovatelem. Aplikace mohou tuto hodnotu použít ve scénářích automatického dopředného řetězení řízeného pravidly k označení zamýšleného logického cíle zprávy.

Další podrobnosti najdete https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding v tématu .

Návratový typ

str,
None