ServiceBusMessage Classe
Message Service Bus.
- Héritage
-
builtins.objectServiceBusMessage
Constructeur
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)Paramètres
- application_properties
- Dict[str, Union[int ou float ou bool ou bytes ou str ou UUID ou datetime ou None]]
L’utilisateur a défini des propriétés sur le message.
Exemples
Envoi d’un message avec des propriétés supplémentaires
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={'data': 'custom_data'},
time_to_live=datetime.timedelta(seconds=30),
label='MyLabel'
)
Attributs
application_properties
body
Corps du message. Le format peut varier en fonction du type de corps : Pour DATA, le corps peut être octets ou itérable[octets]. Pour SEQUENCE, le corps peut être List ou Iterable[List]. Pour VALUE, le corps peut être n’importe quel type.
Type de retour
body_type
content_type
Descripteur de type de contenu.
Décrit éventuellement la charge utile du message, avec un descripteur suivant le format de RFC2045, section 5, par exemple « application/json ».
Type de retour
correlation_id
Identificateur de corrélation.
Cette propriété permet à une application de spécifier un contexte pour le message à des fins de corrélation, qui reflète par exemple l’élément MessageId d’un message recevant une réponse.
Consultez Routage et corrélation des messages dans https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Type de retour
message
Obtenez l’uamqp sous-jacent. Message ou LegacyMessage. Cette option est déconseillée et sera supprimée dans une version ultérieure.
Type de retour
message_id
ID permettant d’identifier le message.
L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile. Cet identificateur est une chaîne à structure libre et peut refléter un identificateur global unique (GUID) ou un identificateur dérivé du contexte de l’application. Si cette option est activée, la fonctionnalité de détection dupliquée (voir https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifie et supprime les deuxièmes envois de messages avec le même ID de message.
Type de retour
partition_key
Clé de partition pour l’envoi d’un message à une entité partitionnée.
La définition de cette valeur permet d’affecter des messages associés à la même partition interne, afin que l’ordre de séquence de soumission soit correctement enregistré. La partition est choisie par une fonction de hachage prioritaire sur cette valeur et ne peut pas être sélectionnée directement.
Consultez Files d’attente et rubriques partitionnés dans https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.
Type de retour
raw_amqp_message
Utilisation avancée uniquement. Charge utile de message AMQP interne envoyée ou reçue. :rtype : ~azure.servicebus.amqp.AmqpAnnotatedMessage
reply_to
Adresse d’une entité à laquelle envoyer des réponses.
Cette valeur facultative et définie par l’application est un moyen standard d’exprimer un chemin d’accès de réponse à l’intention du destinataire du message. Lorsqu’un expéditeur attend une réponse, cette propriété définit cette valeur sur le chemin d’accès absolu ou relatif de la file d’attente ou de la rubrique auxquelles la réponse doit être envoyée.
Consultez Routage et corrélation des messages dans https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Type de retour
reply_to_session_id
Identificateur de session qui augmente l’adresse reply_to .
Cette valeur augmente les informations reply_to et spécifie l’ID de session à définir pour la réponse lorsqu’elle est envoyée à l’entité de réponse.
Consultez Routage et corrélation des messages dans https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Type de retour
scheduled_enqueue_time_utc
Heure d’attente planifiée utc vers le message.
Cette propriété peut être utilisée pour la planification lors de l’envoi d’un message via la méthode ServiceBusSender.send . Si l’annulation des messages planifiés est requise, vous devez utiliser la méthode ServiceBusSender.schedule , qui retourne des numéros de séquence qui peuvent être utilisés pour une annulation ultérieure. scheduled_enqueue_time_utc est Aucun s’il n’est pas défini.
Type de retour
session_id
Identificateur de session du message pour une entité session.
Pour les entités de session, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages dotés du même identificateur de session sont soumis à un verrouillage du résumé et permettent un traitement et un démultiplexage chronologiques. Pour les entités non session, cette valeur est ignorée.
Consultez Sessions de messages dans https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.
Type de retour
subject
Objet spécifique à l’application, parfois appelé étiquette.
Cette propriété permet à l’application d’indiquer de façon normalisée au destinataire la finalité du message, tout comme la ligne Objet d’un e-mail.
Type de retour
time_to_live
Durée de vie d’un message.
Cette valeur correspond à la durée relative après laquelle le message expire, à partir de l’instant où le message a été accepté et stocké par le répartiteur, comme capturé dans enqueued_time_utc. Lorsque cette valeur n’est pas définie explicitement, la valeur prise en compte est celle du paramètre DefaultTimeToLive pour la file d’attente ou la rubrique concernées. Une valeur de durée de vie au niveau du message ne peut pas être plus longue que le paramètre de durée de vie de l’entité et elle est ajustée en mode silencieux si c’est le cas.
Consultez Expiration dans https://docs.microsoft.com/azure/service-bus-messaging/message-expiration
Type de retour
to
à traiter.
Cette propriété est réservée pour une utilisation ultérieure dans les scénarios de routage et est actuellement ignorée par le répartiteur proprement dit. Les applications peuvent utiliser cette valeur dans les scénarios de chaînage de transferts automatiques basés sur des règles afin d’indiquer la destination logique prévue du message.
Consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding pour plus d’informations.
Type de retour
Azure SDK for Python