Megosztás a következőn keresztül:

ServiceBusReceivedMessage Osztály

  • Referencia

Service Bus-üzenet érkezett a szolgáltatásoldalról.

Öröklődés
azure.servicebus._common.message.ServiceBusMessage
ServiceBusReceivedMessage

Konstruktor

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

Paraméterek

Name Description
message
Kötelező
receive_mode
Alapértelmezett érték: ServiceBusReceiveMode.PEEK_LOCK
frame
Alapértelmezett érték: None

Példák

Egy fogadott üzenet tulajdonságainak ellenőrzése.


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

Változók

Name Description
auto_renew_error
<xref:azure.servicebus.AutoLockRenewTimeout> vagy <xref:azure.servicebus.AutoLockRenewFailed>

Hiba az AutoLockRenewer használatakor, és nem újítja meg az üzenetzárat.

Attribútumok

application_properties

A felhasználó definiálta az üzenet tulajdonságait.

Válaszok

Típus Description
dict[str,
bytes, <xref:PrimitiveTypes>],
None

body

Az üzenet törzse. A formátum a törzs típusától függően változhat: a DATAesetében a törzs lehet bájt vagy Iterable[bájt]. A esetében SEQUENCEa törzs lehet List vagy Iterable[List]. A esetében VALUEa test bármilyen típusú lehet.

Válaszok

Típus Description
Any

body_type

A mögöttes AMQP-üzenet törzstípusa.

Válaszok

Típus Description
AmqpMessageBodyType

content_type

A tartalomtípus-leíró.

Ha szeretné, az üzenet hasznos adatait is leírja, egy leíróval, amely a RFC2045 5. szakaszának formátumát követi, például "application/json".

Válaszok

Típus Description
str,
None

correlation_id

A korrelációs azonosító.

Lehetővé teszi, hogy az alkalmazások korreláció céljából megadják az üzenet kontextusát, például egy megválaszolt üzenet MessageId azonosítóját.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Válaszok

Típus Description
str,
None

dead_letter_error_description

Kézbesíthetetlen levelek hibaleírása, amikor az üzenet egy entitás holtponti allekérdezéséből érkezik.

Válaszok

Típus Description
str

dead_letter_reason

Kézbesíthetetlen levél oka, amikor az üzenet egy entitás holtponti allekérdezéséből érkezik.

Válaszok

Típus Description
str

dead_letter_source

Annak az üzenetsornak vagy előfizetésnek a neve, amelyen az üzenet le lett foglalva, mielőtt a rendszer leállt volna. Ez a tulajdonság csak azokban az üzenetekben van beállítva, amelyek kézbesíthetetlen levelek voltak, majd automatikusan továbbítva lettek a kézbesítetlen levelek üzenetsorából egy másik entitásba. Azt az entitást jelzi, amelyben az üzenet kézbesíthetetlen volt.

Válaszok

Típus Description
str

delivery_count

Az üzenethez megkísérelt kézbesítések száma. A szám növekszik, ha egy üzenetzár lejár, vagy a fogadó explicit módon megszakítja az üzenetet.

Válaszok

Típus Description
int

enqueued_sequence_number

Az automatikusan továbbított üzenetek esetében ez a tulajdonság azt a sorszámot tükrözi, amelyet az üzenethez az eredeti küldési ponton először hozzárendeltek.

Válaszok

Típus Description
int

enqueued_time_utc

Az az UTC dátumidő, amikor az üzenetet elfogadták és az entitásban tárolták.

Válaszok

Típus Description
datetime

expires_at_utc

Az az UTC dátumidő, amikor az üzenet eltávolításra van megjelölve, és a lejárat miatt már nem érhető el az entitásból való lekéréshez. A lejáratot a Message.time_to_live tulajdonság szabályozza. Ezt a tulajdonságot Message.enqueued_time_utc Message.time_to_live + számítja ki.

Válaszok

Típus Description
datetime

lock_token

Az aktuális üzenet zárolási jogkivonata a közvetítő által PEEK_LOCK módban tárolt zárolásra mutató hivatkozásként szolgál.

Válaszok

Típus Description
UUID,
str

locked_until_utc

Az UTC dátum/idő, amíg az üzenet zárolva nem lesz az üzenetsorban/előfizetésben. Amikor a zárolás lejár, az üzenet kézbesítési száma növekszik, és az üzenet ismét elérhető lesz a lekéréshez.

Válaszok

Típus Description
datetime

message

Szerezze be a mögöttes LegacyMessage-t. Ez elavult, és egy későbbi kiadásban el lesz távolítva.

Válaszok

Típus Description
<xref:LegacyMessage>

message_id

Az üzenet azonosítására szolgáló azonosító.

Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és annak hasznos adatait. Az azonosító egy szabad formátumú sztring, amely az alkalmazáskörnyezetből származó GUID-t vagy azonosítót tükrözhet. Ha engedélyezve van, a duplikátumészlelés (lásd https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) funkció azonosítja és eltávolítja az azonos üzenetazonosítóval rendelkező üzenetek második és további küldését.

Válaszok

Típus Description
str,
None

partition_key

Az üzenet particionált entitásnak való küldéséhez használt partíciókulcs.

Ennek az értéknek a beállítása lehetővé teszi a kapcsolódó üzenetek hozzárendelését ugyanahhoz a belső partícióhoz, hogy a küldési sorrend helyesen legyen rögzítve. A partíciót egy kivonatfüggvény választja ki ezen az értéken, és nem választható ki közvetlenül.

Lásd: Particionált üzenetsorok és témakörök a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning: .

Válaszok

Típus Description
str,
None

raw_amqp_message

Csak speciális használat. Az elküldött vagy fogadott belső AMQP-üzenet hasznos adatai. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Annak az entitásnak a címe, amelynek válaszokat szeretne küldeni.

Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet címzettjének küldött válaszútvonal kifejezésére. Amikor egy feladó választ vár, az értéket annak az üzenetsornak vagy témakörnek az abszolút vagy relatív elérési útjára állítja be, amelyre a választ el szeretné küldeni.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Válaszok

Típus Description
str,
None

reply_to_session_id

A reply_to címet kiegészítő munkamenet-azonosító.

Ez az érték kibővíti a reply_to adatokat, és megadja, hogy a válasz entitásnak küldött válaszhoz melyik munkamenet-azonosítót kell beállítani.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Válaszok

Típus Description
str,
None

scheduled_enqueue_time_utc

Az üzenet utc-beütemezett beiktatási ideje.

Ez a tulajdonság használható az üzenetek ServiceBusSender.send metóduson keresztüli küldésekor történő ütemezéshez. Ha az ütemezett üzenetek törlésére van szükség, a ServiceBusSender.schedule metódust kell használnia, amely a jövőbeli lemondáshoz használható sorszámokat adja vissza. scheduled_enqueue_time_utc Nincs, ha nincs beállítva.

Válaszok

Típus Description
datetime

sequence_number

A Service Bus által egy üzenethez rendelt egyedi szám. A sorszám egy üzenethez rendelt egyedi 64 bites egész szám, amelyet a közvetítő elfogad és tárol, és valódi azonosítóként működik. Particionált entitások esetén a legfelső 16 bit a partícióazonosítót tükrözi. A sorszámok monoton módon növekednek. A 48–64 bites tartomány kimerítésekor 0-ra állnak át.

Válaszok

Típus Description
int

session_id

Egy munkamenet-entitás üzenetének munkamenet-azonosítója.

Munkamenet-entitások esetén ez az alkalmazás által definiált érték határozza meg az üzenet munkamenet-kapcsolatát. Az azonos munkamenet-azonosítóval rendelkező üzenetekre összefoglaló zárolás vonatkozik, és lehetővé teszi a pontos sorrendben történő feldolgozást és demultiplexinget. A nem munkamenet-alapú entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket.

Lásd: Üzenet-munkamenetek a következőben https://docs.microsoft.com/azure/service-bus-messaging/message-sessions: .

Válaszok

Típus Description
str,
None

state

Alapértelmezés szerint Aktív. Az üzenet üzenetállapotát jelöli. Lehet Aktív, Késleltetve. vagy Ütemezett.

Válaszok

Típus Description
ServiceBusMessageState

subject

Az alkalmazásspecifikus téma, más néven címke.

Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított módon jelezze az üzenet célját a fogadónak, hasonlóan az e-mail tárgysorához.

Válaszok

Típus Description
str

time_to_live

Az üzenet élettartama.

Ez az érték az a relatív időtartam, amely után az üzenet lejár, attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet a enqueued_time_utc rögzített módon. Ha nincs explicit módon beállítva, a feltételezett érték a megfelelő üzenetsor vagy témakör DefaultTimeToLive értéke. Az üzenetszintű élettartam értéke nem lehet hosszabb, mint az entitás élettartam-beállítása, és ha igen, csendesen módosul.

Lásd: Lejárat a következőben: https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Válaszok

Típus Description
timedelta

to

A címzett.

Ezt a tulajdonságot az útválasztási forgatókönyvek későbbi használatra fenntartják, és a közvetítő jelenleg figyelmen kívül hagyja. Az alkalmazások ezt az értéket szabályalapú automatikus továbbítási láncolásos forgatókönyvekben használhatják az üzenet kívánt logikai céljának jelzésére.

További részletekért lásd https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding : .

Válaszok

Típus Description
str,
None