ServiceBusReceivedMessage Classe

Message Service Bus reçu côté service.

Héritage

azure.servicebus._common.message.ServiceBusMessage

ServiceBusReceivedMessage

Constructeur

ServiceBusReceivedMessage(message: 'Message' | 'pyamqp_Message', receive_mode: ServiceBusReceiveMode | str = ServiceBusReceiveMode.PEEK_LOCK, frame: 'TransferFrame' | None = None, **kwargs: Any)

Paramètres

Nom	Description
message Obligatoire
receive_mode	Valeur par défaut: ServiceBusReceiveMode.PEEK_LOCK
frame	Valeur par défaut: None

Exemples

Vérification des propriétés sur un message reçu.

       from typing import List
       from azure.servicebus import ServiceBusReceivedMessage
       messages_complex: List[ServiceBusReceivedMessage] = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages_complex:
           print("Receiving: {}".format(message))
           print("Time to live: {}".format(message.time_to_live))
           print("Sequence number: {}".format(message.sequence_number))
           print("Enqueued Sequence number: {}".format(message.enqueued_sequence_number))
           print("Partition Key: {}".format(message.partition_key))
           print("Application Properties: {}".format(message.application_properties))
           print("Delivery count: {}".format(message.delivery_count))
           print("Message ID: {}".format(message.message_id))
           print("Locked until: {}".format(message.locked_until_utc))
           print("Lock Token: {}".format(message.lock_token))
           print("Enqueued time: {}".format(message.enqueued_time_utc))

Variables

Nom	Description
auto_renew_error	<xref:azure.servicebus.AutoLockRenewTimeout> ou <xref:azure.servicebus.AutoLockRenewFailed> Erreur quand AutoLockRenewer est utilisé et qu’il ne parvient pas à renouveler le verrou de message.

Attributs

application_properties

Propriétés définies par l’utilisateur sur le message.

Retours

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

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.

Retours

Type	Description
Any

body_type

Type de corps du message AMQP sous-jacent.

Retours

Type	Description
AmqpMessageBodyType

content_type

Descripteur de type de contenu.

Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ».

Retours

Type	Description
str, None

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.

Retours

Type	Description
str, None

dead_letter_error_description

Description de l’erreur de lettre morte, lorsque le message est reçu d’une sous-file d’attente de lettres mortes d’une entité.

Retours

Type	Description
str

dead_letter_reason

Raison de la lettre morte, lorsque le message est reçu d’une sous-file d’attente de lettres mortes d’une entité.

Retours

Type	Description
str

dead_letter_source

Nom de la file d’attente ou de l’abonnement sur lequel ce message a été mis en file d’attente, avant qu’il ne soit mis en file d’attente. Cette propriété est définie uniquement dans les messages qui ont été mis en lettres mortes puis automatiquement transférés de la file d’attente de lettres mortes vers une autre entité. Elle indique l’entité dans laquelle le message a été placé comme message de lettres mortes.

Retours

Type	Description
str

delivery_count

Cette propriété indique le nombre de tentatives de remise de ce message. Le nombre est incrémenté lorsqu’un verrou de message expire ou que le message est explicitement abandonné par le récepteur.

Retours

Type	Description
int

enqueued_sequence_number

Dans le cas des messages qui ont été transférés automatiquement, cette propriété reflète le numéro de séquence qui avait été initialement attribué au message à son point d’envoi d’origine.

Retours

Type	Description
int

enqueued_time_utc

Date UTC à laquelle le message a été accepté et stocké dans l’entité.

Retours

Type	Description
datetime

expires_at_utc

Date utc à laquelle le message est marqué pour suppression et n’est plus disponible pour récupération à partir de l’entité en raison de l’expiration. L’expiration est contrôlée par la propriété Message.time_to_live . Cette propriété est calculée à partir de Message.enqueued_time_utc + Message.time_to_live.

Retours

Type	Description
datetime

lock_token

Jeton de verrouillage du message actuel servant de référence au verrou détenu par le répartiteur en mode PEEK_LOCK.

Retours

Type	Description
UUID, str

locked_until_utc

Date UTC jusqu’à laquelle le message sera verrouillé dans la file d’attente/l’abonnement. Lorsque le verrou expire, le nombre de remises du message est incrémenté et le message est à nouveau disponible pour récupération.

Retours

Type	Description
datetime

message

Obtenez le LegacyMessage sous-jacent. Cette option est déconseillée et sera supprimée dans une version ultérieure.

Retours

Type	Description
<xref:LegacyMessage>

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 elle est activée, la fonctionnalité de détection des doublons (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.

Retours

Type	Description
str, None

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 connexes à 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.

Retours

Type	Description
str, None

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.

Retours

Type	Description
str, None

reply_to_session_id

Identificateur de session qui augmente l’adresse reply_to .

Cette valeur augmente les informations de reply_to et spécifie l’ID de session à définir pour la réponse lors de l’envoi à 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.

Retours

Type	Description
str, None

scheduled_enqueue_time_utc

Heure de mise en file 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.

Retours

Type	Description
datetime

sequence_number

Numéro unique attribué à un message par Service Bus. Le numéro de séquence est un entier 64 bits unique attribué à un message lorsque celui-ci est accepté et stocké par le répartiteur, et fait office de véritable identificateur du message. Pour les entités partitionnées, les 16 premiers bits correspondent à l’identificateur de la partition. Les nombres de séquences augmentent de façon monotone. Ils repassent à 0 lorsque la plage 48 à 64 bits est épuisée.

Retours

Type	Description
int

session_id

Identificateur de session du message pour une entité de 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.

Retours

Type	Description
str, None

state

La valeur par défaut est Active. Représente l’état du message. Peut être Actif, Différé. ou Planifié.

Retours

Type	Description
ServiceBusMessageState

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.

Retours

Type	Description
str

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, tel que 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 supérieure au paramètre de durée de vie de l’entité, et elle est ajustée en mode silencieux si c’est le cas.

Voir Expiration dans https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Retours

Type	Description
timedelta

to

à l’adresse.

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.

Retours

Type	Description
str, None