ServiceBusReceivedMessage Klas

Een Service Bus-bericht ontvangen van de servicezijde.

Overname

azure.servicebus._common.message.ServiceBusMessage

ServiceBusReceivedMessage

Constructor

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

Parameters

Name	Description
message Vereist
receive_mode	Default value: ServiceBusReceiveMode.PEEK_LOCK
frame	Default value: None

Voorbeelden

De eigenschappen van een ontvangen bericht controleren.

       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))

Variabelen

Name	Description
auto_renew_error	<xref:azure.servicebus.AutoLockRenewTimeout> of <xref:azure.servicebus.AutoLockRenewFailed> Fout wanneer AutoLockRenewer wordt gebruikt en het vernieuwen van de berichtvergrendeling mislukt.

Kenmerken

application_properties

De door de gebruiker gedefinieerde eigenschappen voor het bericht.

Retouren

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

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.

Retouren

Type	Description
Any

body_type

Het hoofdteksttype van het onderliggende AMQP-bericht.

Retouren

Type	Description
AmqpMessageBodyType

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.

Retouren

Type	Description
str, None

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.

Retouren

Type	Description
str, None

dead_letter_error_description

Beschrijving van de fout in onbestelbare letters, wanneer het bericht wordt ontvangen van een in de wachtrij geplaatste postbus van een entiteit.

Retouren

Type	Description
str

dead_letter_reason

Reden voor onbestelbare brief, wanneer het bericht wordt ontvangen van een in de wachtrij geplaatste postbus van een entiteit.

Retouren

Type	Description
str

dead_letter_source

De naam van de wachtrij of het abonnement waarvoor dit bericht is verzonden, voordat het werd opgeslagen. Deze eigenschap wordt alleen ingesteld in berichten die met een onbestelbare brief zijn geschreven en vervolgens automatisch zijn doorgestuurd vanuit de wachtrij met onbestelbare berichten naar een andere entiteit. Hiermee wordt de entiteit aangegeven waarin het bericht onbestelbaar is.

Retouren

Type	Description
str

delivery_count

Aantal leveringen dat voor dit bericht is geprobeerd. Het aantal wordt verhoogd wanneer een berichtvergrendeling verloopt of het bericht expliciet wordt afgelaten door de ontvanger.

Retouren

Type	Description
int

enqueued_sequence_number

Voor berichten die automatisch zijn doorgestuurd, weerspiegelt deze eigenschap het volgnummer dat voor het eerst aan het bericht was toegewezen op het oorspronkelijke moment van verzending.

Retouren

Type	Description
int

enqueued_time_utc

De UTC-datum/tijd waarop het bericht is geaccepteerd en opgeslagen in de entiteit.

Retouren

Type	Description
datetime

expires_at_utc

De UTC-datum/tijd waarop het bericht is gemarkeerd voor verwijdering en niet meer beschikbaar is voor ophalen van de entiteit vanwege de vervaldatum. Verloop wordt bepaald door de eigenschap Message.time_to_live . Deze eigenschap wordt berekend op basis van Message.enqueued_time_utc + Message.time_to_live.

Retouren

Type	Description
datetime

lock_token

Het vergrendelingstoken voor het huidige bericht dat fungeert als een verwijzing naar de vergrendeling die wordt vastgehouden door de broker in PEEK_LOCK modus.

Retouren

Type	Description
UUID, str

locked_until_utc

De UTC-datum/tijd totdat het bericht wordt vergrendeld in de wachtrij/het abonnement. Wanneer de vergrendeling verloopt, wordt het aantal bezorging van het bericht verhoogd en kan het bericht opnieuw worden opgehaald.

Retouren

Type	Description
datetime

message

Haal de onderliggende LegacyMessage op. Dit is afgeschaft en wordt verwijderd in een latere release.

Retouren

Type	Description
<xref:LegacyMessage>

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.

Retouren

Type	Description
str, None

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.

Retouren

Type	Description
str, None

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.

Retouren

Type	Description
str, None

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.

Retouren

Type	Description
str, None

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.

Retouren

Type	Description
datetime

sequence_number

Het unieke nummer dat door Service Bus aan een bericht is toegewezen. Het volgnummer is een uniek 64-bits geheel getal dat is toegewezen aan een bericht omdat het wordt geaccepteerd en opgeslagen door de broker en fungeert als de ware id. Voor gepartitioneerde entiteiten weerspiegelen de bovenste 16 bits de partitie-id. Volgnummers nemen monotonisch toe. Ze rollen over naar 0 wanneer het 48-64-bits bereik is uitgeput.

Retouren

Type	Description
int

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.

Retouren

Type	Description
str, None

state

De standaardinstelling is Actief. Vertegenwoordigt de berichtstatus van het bericht. Kan actief zijn, uitgestelde. of Gepland.

Retouren

Type	Description
ServiceBusMessageState

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.

Retouren

Type	Description
str

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

Retouren

Type	Description
timedelta

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.

Retouren

Type	Description
str, None