ServiceBusMessage Klasse
Eine Service Bus-Nachricht.
- Vererbung
-
builtins.objectServiceBusMessage
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)Parameter
Die Daten, die in einer einzelnen Nachricht gesendet werden sollen.
- application_properties
- Dict[str, Union[int oder float oder bool oder bytes oder str oder UUID oder datetime oder None]]
Die benutzerdefinierten Eigenschaften für die Nachricht.
Der Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität.
Beispiele
Senden einer Nachricht mit zusätzlichen Eigenschaften
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={'data': 'custom_data'},
time_to_live=datetime.timedelta(seconds=30),
label='MyLabel'
)
Attribute
application_properties
body
Der Textkörper der Nachricht. Das Format kann je nach Textkörpertyp variieren: Für DATAkann der Text Bytes oder Iterable[Bytes] sein. Für SEQUENCEkönnte der Text list oder Iterable[List] sein. Für VALUEkann der Textkörper ein beliebiger Typ sein.
Rückgabetyp
body_type
content_type
Die Inhaltstypdeskriptor.
Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json".
Rückgabetyp
correlation_id
Der Korrelationsbezeichner.
Ermöglicht einer Anwendung, einen Kontext für die Nachricht zum Zweck der Korrelation anzugeben, z.B. die MessageId einer Nachricht, auf die geantwortet wird.
Siehe Nachrichtenrouting und Korrelation in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Rückgabetyp
message
Rufen Sie die zugrunde liegende uamqp ab. Nachricht oder LegacyMessage. Dies ist veraltet und wird in einer späteren Version entfernt.
Rückgabetyp
message_id
Die ID zum Identifizieren der Nachricht.
Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert. Der Bezeichner ist eine Zeichenfolge in freier Form und kann eine GUID oder einen aus dem Anwendungskontext abgeleiteten Bezeichner widerspiegeln. Wenn diese Option aktiviert ist, identifiziert und entfernt das Feature "Duplikaterkennung" (siehe https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) die zweite und weitere Übermittlung von Nachrichten mit derselben Nachrichten-ID.
Rückgabetyp
partition_key
Der Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität.
Wenn Sie diesen Wert festlegen, können Sie der gleichen internen Partition verwandte Nachrichten zuweisen, sodass die Reihenfolge der Übermittlungssequenz ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion über diesen Wert ausgewählt und kann nicht direkt ausgewählt werden.
Weitere Informationen finden Sie unter Partitionierte Warteschlangen und Themen in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.
Rückgabetyp
raw_amqp_message
Nur erweiterte Nutzung. Die gesendete oder empfangene interne AMQP-Nachrichtennutzlast. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage
reply_to
Die Adresse einer Entität, an die Antworten gesendet werden sollen.
Dieser optionale und von der Anwendung definierte Wert ist eine Standardmethode, einen Antwortpfad zum Empfänger der Nachricht auszudrücken. Wenn ein Absender eine Antwort erwartet, legt er den Wert auf den absoluten oder relativen Pfad der Warteschlange oder des Themas fest, an den bzw. das die Antwort gesendet werden soll.
Siehe Nachrichtenrouting und Korrelation in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Rückgabetyp
reply_to_session_id
Der Sitzungsbezeichner, der die reply_to-Adresse erweitert.
Dieser Wert erweitert die reply_to Informationen und gibt an, welche Sitzungs-ID für die Antwort festgelegt werden soll, wenn sie an die Antwortentität gesendet wird.
Siehe Nachrichtenrouting und Korrelation in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Rückgabetyp
scheduled_enqueue_time_utc
Die geplante utc-Queuezeit für die Nachricht.
Diese Eigenschaft kann für die Planung verwendet werden, wenn eine Nachricht über die ServiceBusSender.send-Methode gesendet wird. Wenn das Abbrechen geplanter Nachrichten erforderlich ist, sollten Sie die ServiceBusSender.schedule-Methode verwenden, die Sequenznummern zurückgibt, die für zukünftige Abbruchvorgänge verwendet werden können. scheduled_enqueue_time_utc ist Keine, wenn nicht festgelegt.
Rückgabetyp
session_id
Der Sitzungsbezeichner der Nachricht für eine sitzungsbehaftete Entität.
Für sitzungsbehaftete Entitäten gibt dieser anwendungsdefinierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen einer zusammenfassenden Sperre und ermöglichen eine Verarbeitung in exakter Reihenfolge und Demultiplexing. Für Entitäten, die nicht sitzungsbehaftet sind, wird dieser Wert ignoriert.
Siehe Nachrichtensitzungen in https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.
Rückgabetyp
subject
Der anwendungsspezifische Betreff, manchmal auch als Bezeichnung bezeichnet.
Diese Eigenschaft ermöglicht der Anwendung, dem Empfänger auf standardisierte Weise den Zweck der Nachricht anzuzeigen, ähnlich einer Betreffzeile für E-Mails.
Rückgabetyp
time_to_live
Die Lebensdauer einer Nachricht.
Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, ab dem Moment, an dem die Nachricht vom Broker akzeptiert und gespeichert wurde, wie in enqueued_time_utc erfasst. Falls nicht explizit festgelegt, ist der angenommene Wert der DefaultTimeToLive-Wert für die jeweilige Warteschlange oder das jeweilige Thema. Ein Time-to-Live-Wert auf Nachrichtenebene darf nicht länger als die Einstellung für die Laufzeit der Entität sein, und er wird automatisch angepasst, wenn dies der Fall ist.
Siehe Ablauf in https://docs.microsoft.com/azure/service-bus-messaging/message-expiration
Rückgabetyp
to
The to address.
Diese Eigenschaft ist für die künftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelbasierten Verkettungsszenarien für die automatische Weiterleitung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.
Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding.
Rückgabetyp
Azure SDK for Python