ServiceBusMessage Klas
Een Service Bus-bericht.
- Overname
-
builtins.objectServiceBusMessage
Constructor
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)Parameters
- application_properties
- Dict[str, Union[int of float of bool of bytes of str of UUID of datetime of None]]
De door de gebruiker gedefinieerde eigenschappen voor het bericht.
De geplande utc-tijd in de wachtrij plaatsen voor het bericht.
De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit.
Voorbeelden
Een bericht met aanvullende eigenschappen verzenden
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={'data': 'custom_data'},
time_to_live=datetime.timedelta(seconds=30),
label='MyLabel'
)
Kenmerken
application_properties
De door de gebruiker gedefinieerde eigenschappen voor het bericht.
Retourtype
body
De hoofdtekst van het bericht. De indeling kan variëren, afhankelijk van het type hoofdtekst: Voor DATAkan de hoofdtekst bytes of Iterable[bytes] zijn. Voor SEQUENCEkan de hoofdtekst Lijst of Iterable[List] zijn. Voor VALUEkan de hoofdtekst elk type zijn.
Retourtype
body_type
content_type
De beschrijving van het inhoudstype.
Beschrijft eventueel de nettolading van het bericht, met een descriptor die de indeling van RFC2045, sectie 5, bijvoorbeeld 'application/json' volgt.
Retourtype
correlation_id
De correlatie-id.
Hiermee kan een toepassing een context opgeven voor het bericht met het oog op correlatie, bijvoorbeeld door de MessageId weer te geven van een bericht dat wordt beantwoord.
Zie Berichtroutering en -correlatie in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Retourtype
message
Haal de onderliggende uamqp op. Message of LegacyMessage. Dit is afgeschaft en wordt verwijderd in een latere release.
Retourtype
message_id
De id om het bericht te identificeren.
De bericht-id is een door de toepassing gedefinieerde waarde die het bericht en de nettolading uniek identificeert. De id is een vrije tekenreeks en kan een GUID of een id weergeven die is afgeleid van de context van de toepassing. Als dit is ingeschakeld, worden met de functie voor duplicaatdetectie (zie https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) tweede en verdere verzendingen van berichten met dezelfde bericht-id geïdentificeerd en verwijderd.
Retourtype
partition_key
De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit.
Als u deze waarde instelt, kunt u gerelateerde berichten toewijzen aan dezelfde interne partitie, zodat de volgorde van de indieningsvolgorde correct wordt vastgelegd. De partitie wordt gekozen door een hash-functie boven deze waarde en kan niet rechtstreeks worden gekozen.
Zie Gepartitioneerde wachtrijen en onderwerpen in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.
Retourtype
raw_amqp_message
Alleen geavanceerd gebruik. De nettolading van het interne AMQP-bericht die wordt verzonden of ontvangen. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage
reply_to
Het adres van een entiteit waarnaar u antwoorden wilt verzenden.
Deze optionele en door de toepassing gedefinieerde waarde is een standaardmethode om een antwoordpad naar de ontvanger van het bericht uit te drukken. Wanneer een afzender een antwoord verwacht, wordt de waarde ingesteld op het absolute of relatieve pad van de wachtrij of het onderwerp waarnaar het antwoord moet worden verzonden.
Zie Berichtroutering en -correlatie in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Retourtype
reply_to_session_id
De sessie-id die het adres van de reply_to vergroot.
Deze waarde vergroot de reply_to informatie en geeft aan welke sessie-id moet worden ingesteld voor het antwoord wanneer deze naar de antwoordentiteit wordt verzonden.
Zie Berichtroutering en -correlatie in https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Retourtype
scheduled_enqueue_time_utc
De geplande utc-tijd in de wachtrij plaatsen voor het bericht.
Deze eigenschap kan worden gebruikt voor het plannen van het verzenden van een bericht via de methode ServiceBusSender.send . Als het annuleren van geplande berichten is vereist, moet u de methode ServiceBusSender.schedule gebruiken, waarmee volgnummers worden geretourneerd die kunnen worden gebruikt voor toekomstige annuleringen. scheduled_enqueue_time_utc is Geen als dit niet is ingesteld.
Retourtype
session_id
De sessie-id van het bericht voor een sessievolle entiteit.
Voor sessievolle entiteiten geeft deze toepassingsgedefinieerde waarde de sessierelatie van het bericht op. Berichten met dezelfde sessie-id zijn onderhevig aan samenvattingsvergrendeling en maken exacte verwerking en demultiplexing mogelijk. Voor niet-sessievolle entiteiten wordt deze waarde genegeerd.
Zie Berichtsessies in https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.
Retourtype
subject
Het toepassingsspecifieke onderwerp, ook wel een label genoemd.
Met deze eigenschap kan de toepassing het doel van het bericht op een gestandaardiseerde manier aan de ontvanger aangeven, vergelijkbaar met de onderwerpregel van een e-mail.
Retourtype
time_to_live
De levensduur van een bericht.
Deze waarde is de relatieve duur waarna het bericht verloopt, beginnend vanaf het moment dat het bericht is geaccepteerd en opgeslagen door de broker, zoals vastgelegd in enqueued_time_utc. Wanneer deze niet expliciet is ingesteld, is de veronderstelde waarde de DefaultTimeToLive voor de respectieve wachtrij of het betreffende onderwerp. Een time-to-live-waarde op berichtniveau mag niet langer zijn dan de time-to-live-instelling van de entiteit en wordt op de achtergrond aangepast als dat het geval is.
Zie Vervaldatum in https://docs.microsoft.com/azure/service-bus-messaging/message-expiration
Retourtype
to
De aan adres .
Deze eigenschap is gereserveerd voor toekomstig gebruik in routeringsscenario's en wordt momenteel genegeerd door de broker zelf. Toepassingen kunnen deze waarde gebruiken in regelgestuurde scenario's voor het automatisch doorsturen van ketens om de beoogde logische bestemming van het bericht aan te geven.
Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding voor meer informatie.
Retourtype
Azure SDK for Python