ServiceBusMessage Klass

Ett Service Bus-meddelande.

Arv

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)

Parametrar

body

Optional[Union[str, bytes]]

Obligatorisk

De data som ska skickas i ett enda meddelande.

application_properties

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

De användardefinierade egenskaperna för meddelandet.

session_id

Optional[str]

Sessionsidentifieraren för meddelandet för en sessionskänslig entitet.

message_id

Optional[str]

ID:t för att identifiera meddelandet.

scheduled_enqueue_time_utc

Optional[datetime]

Den schemalagda utc-inmatningstiden för meddelandet.

time_to_live

Optional[timedelta]

Ett meddelandes varaktighet.

content_type

Optional[str]

Innehållstypsbeskrivningen.

correlation_id

Optional[str]

Korrelationsidentifieraren.

subject

Optional[str]

Det programspecifika ämnet, som ibland kallas etikett.

partition_key

Optional[str]

Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet.

to

Optional[str]

Till-adressen som används för auto_forward länkningsscenarier.

reply_to

Optional[str]

Adressen till en entitet som svar ska skickas till.

reply_to_session_id

Optional[str]

Sessionsidentifieraren som utökar reply_to-adressen .

Exempel

Skicka ett meddelande med ytterligare egenskaper

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

Attribut

application_properties

De användardefinierade egenskaperna för meddelandet.

Returtyp

dict[str,

bytes, <xref:PrimitiveTypes>],

None

body

Brödtexten i meddelandet. Formatet kan variera beroende på brödtexttyp: För DATAkan brödtexten vara byte eller Iterable[bytes]. För SEQUENCEkan brödtexten vara List eller Iterable[List]. För VALUEkan brödtexten vara vilken typ som helst.

Returtyp

Any

body_type

Brödtexttypen för det underliggande AMQP-meddelandet.

Returtyp

AmqpMessageBodyType

content_type

Innehållstypsbeskrivningen.

Du kan också beskriva nyttolasten för meddelandet, med en beskrivning som följer formatet RFC2045, avsnitt 5, till exempel "application/json".

Returtyp

str,

None

correlation_id

Korrelationsidentifieraren.

Gör att ett program kan ange en kontext för meddelandet i samband med korrelation, till exempel för att återspegla MessageId för ett meddelande som besvaras.

Se Meddelanderoutning och korrelation i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Returtyp

str,

None

message

Hämta den underliggande uamqp. Message eller LegacyMessage. Detta är inaktuellt och tas bort i en senare version.

Returtyp

<xref:uamqp.Message>,

<xref:LegacyMessage>

message_id

ID:t för att identifiera meddelandet.

Meddelandeidentifieraren är ett programdefinierat värde som unikt identifierar meddelandet och dess nyttolast. Identifieraren är en friformssträng och kan återspegla ett GUID eller en identifierare som härletts från programkontexten. Om funktionen för dubblettidentifiering (se https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) är aktiverad identifieras och tas andra och ytterligare meddelanden med samma meddelande-ID bort.

Returtyp

str,

None

partition_key

Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet.

Om du anger det här värdet kan relaterade meddelanden tilldelas till samma interna partition, så att sekvensordningen för överföring registreras korrekt. Partitionen väljs av en hash-funktion framför det här värdet och kan inte väljas direkt.

Se Partitionerade köer och ämnen i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Returtyp

str,

None

raw_amqp_message

Endast avancerad användning. Den interna AMQP-meddelandenyttolasten som skickas eller tas emot. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Adressen till en entitet som svar ska skickas till.

Det här valfria och programdefinierade värdet är ett standardsätt för att uttrycka en svarssökväg till mottagaren av meddelandet. När en avsändare förväntar sig ett svar anges värdet till den absoluta eller relativa sökvägen för kön eller ämnet som svaret ska skickas till.

Se Meddelanderoutning och korrelation i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Returtyp

str,

None

reply_to_session_id

Sessionsidentifieraren som utökar reply_to-adressen .

Det här värdet utökar reply_to information och anger vilket sessions-ID som ska anges för svaret när det skickas till svarsentiteten.

Se Meddelanderoutning och korrelation i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Returtyp

str,

None

scheduled_enqueue_time_utc

Den schemalagda utc-inmatningstiden för meddelandet.

Den här egenskapen kan användas för schemaläggning när du skickar ett meddelande via serviceBusSender.send-metoden . Om det krävs att schemalagda meddelanden avbryts bör du använda metoden ServiceBusSender.schedule , som returnerar sekvensnummer som kan användas för framtida annullering. scheduled_enqueue_time_utc är Ingen om den inte har angetts.

Returtyp

datetime

session_id

Sessionsidentifieraren för meddelandet för en sessionskänslig entitet.

För sessionskänsliga entiteter anger det här programdefinierade värdet sessionstillhörigheten för meddelandet. Meddelanden med samma sessionsidentifierare omfattas av sammanfattningslåsning och möjliggör exakt bearbetning i ordning och demultiplexing. För icke-sessionskänsliga entiteter ignoreras det här värdet.

Se Meddelandesessioner i https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Returtyp

str,

None

subject

Det programspecifika ämnet, som ibland kallas för en etikett.

Den här egenskapen gör det möjligt för programmet att ange syftet med meddelandet till mottagaren på ett standardiserat sätt, ungefär som en ämnesrad för e-post.

Returtyp

str

time_to_live

Ett meddelandes varaktighet.

Det här värdet är den relativa varaktigheten efter vilken meddelandet upphör att gälla, med början från det ögonblick då meddelandet har accepterats och lagrats av den asynkrona meddelandekön enligt enqueued_time_utc. När det inte anges explicit är det antagna värdet DefaultTimeToLive för respektive kö eller ämne. Ett time to live-värde på meddelandenivå får inte vara längre än entitetens time to live-inställning och justeras tyst om den gör det.

Se Förfallodatum i https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Returtyp

timedelta

to

Till-adressen.

Den här egenskapen är reserverad för framtida användning i routningsscenarier och ignoreras för närvarande av själva koordinatorn. Program kan använda det här värdet i regeldrivna scenarier för automatisk vidarebefordran av länkning för att ange meddelandets avsedda logiska mål.

Mer https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding information finns i.

Returtyp

str,

None