ServiceBusMessage interface

Csomag:

@azure/service-bus

A Service Busnak küldendő üzenetet ismerteti.

Tulajdonságok

applicationProperties	Az egyéni üzenet metaadataihoz használható alkalmazásspecifikus tulajdonságok.
body	Az elküldendő vagy fogadott üzenet törzse. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbre vagy pufferre a jobb nyelvközi kompatibilitás érdekében.
contentType	Az üzenet tartalomtípusa. Opcionálisan az üzenet hasznos adatait írja le egy leíróval, amely a RFC2045 5. szakaszának formátumát követi, például "application/json".
correlationId	Az a korrelációs azonosító, amely lehetővé teszi az alkalmazás számára az üzenet kontextusának megadását korreláció céljából, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenet útválasztása és korrelációs.
messageId	Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és a hasznos adatokat. Megjegyzés: A nem egész egész számokat tartalmazó számok nem engedélyezettek.
partitionKey	A particionált entitásnak küldött üzenet partíciókulcsa. A maximális hossz 128 karakter. Az particionált entitásokbeállításával a kapcsolódó üzenetek ugyanahhoz a belső partícióhoz rendelhetők, így a rendszer helyesen rögzíti a küldési sorrendet. A partíciót egy kivonatfüggvény választja ki ezen az értéken keresztül, és nem választható ki közvetlenül. A munkamenet-tudatos entitások esetében a sessionId tulajdonság felülírja ezt az értéket. Nem particionált entitások esetén a partíciókulcs figyelmen kívül lesz hagyva
replyTo	Egy entitás címe, amelybe válaszokat szeretne küldeni. Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet fogadójának válaszútvonalának kifejezésére. Amikor a 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álasz elküldése várható. Lásd: Üzenet útválasztása és korrelációs.
replyToSessionId	A replyTo címet bővítő munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-adatokat, és meghatározza, hogy a válasz entitásnak küldött válaszhoz melyik SessionId legyen beállítva. Lásd: Üzenet útválasztása és korrelációs.
scheduledEnqueueTimeUtc	Az a dátum és idő UTC-ben, amikor az üzenet le lesz iktatva. Ez a tulajdonság utc-ben adja vissza az időt; a tulajdonság beállításakor a megadott DateTime értéknek IS UTC-ben kell lennie. Ez az érték késleltetett üzenetküldésre használható. A későbbiekben egy adott időpontra küldött üzenetek késleltetésére használható. Az üzenet lekérdezési ideje nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer lekéri, de a tényleges küldési idő az üzenetsor számítási feladatától és állapotától függ.
sessionId	Egy munkamenet-tudatos entitás munkamenet-azonosítója. A maximális hossz 128 karakter. A munkamenet-tudatos entitások esetében 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é teszik a pontos sorrendben történő feldolgozást és a demultiplexinget. A munkamenet-nem tudó entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket. üzenet-munkamenetek.
subject	Az alkalmazásspecifikus címke. Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított formátumban jelezze az üzenet célját a fogadónak. divat, hasonló egy e-mail tárgysor. A hozzárendelt AMQP tulajdonság "subject".
timeToLive	Az üzenet ideje az élő értékre. Ez az érték az a relatív időtartam, amely után az üzenet lejár, kezdve attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet, amint az enqueuedTimeUtcrögzítette. 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ű timeToLive érték nem lehet hosszabb az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosul. Lásd: Lejárati.
to	A "címzett" cím. Ez a tulajdonság az útválasztási forgatókönyvekben való jövőbeli használatra van fenntartva, és jelenleg maga a közvetítő figyelmen kívül hagyja. Az alkalmazások ezt az értéket a szabályalapú automatikus továbbítási láncolás forgatókönyvekben használhatják az üzenet kívánt logikai célhelyének jelzésére.

Tulajdonság adatai

applicationProperties

Az egyéni üzenet metaadataihoz használható alkalmazásspecifikus tulajdonságok.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Tulajdonság értéke

{[key: string]: number | boolean | string | Date | null}

body

Az elküldendő vagy fogadott üzenet törzse. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbre vagy pufferre a jobb nyelvközi kompatibilitás érdekében.

body: any

Tulajdonság értéke

any

contentType

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

contentType?: string

Tulajdonság értéke

string

correlationId

Az a korrelációs azonosító, amely lehetővé teszi az alkalmazás számára az üzenet kontextusának megadását korreláció céljából, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenet útválasztása és korrelációs.

correlationId?: string | number | Buffer

Tulajdonság értéke

string | number | Buffer

messageId

Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és a hasznos adatokat.

Megjegyzés: A nem egész egész számokat tartalmazó számok nem engedélyezettek.

messageId?: string | number | Buffer

Tulajdonság értéke

string | number | Buffer

partitionKey

A particionált entitásnak küldött üzenet partíciókulcsa. A maximális hossz 128 karakter. Az particionált entitásokbeállításával a kapcsolódó üzenetek ugyanahhoz a belső partícióhoz rendelhetők, így a rendszer helyesen rögzíti a küldési sorrendet. A partíciót egy kivonatfüggvény választja ki ezen az értéken keresztül, és nem választható ki közvetlenül.

• A munkamenet-tudatos entitások esetében a sessionId tulajdonság felülírja ezt az értéket.
• Nem particionált entitások esetén a partíciókulcs figyelmen kívül lesz hagyva

partitionKey?: string

Tulajdonság értéke

string

replyTo

Egy entitás címe, amelybe válaszokat szeretne küldeni. Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet fogadójának válaszútvonalának kifejezésére. Amikor a 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álasz elküldése várható. Lásd: Üzenet útválasztása és korrelációs.

replyTo?: string

Tulajdonság értéke

string

replyToSessionId

A replyTo címet bővítő munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-adatokat, és meghatározza, hogy a válasz entitásnak küldött válaszhoz melyik SessionId legyen beállítva. Lásd: Üzenet útválasztása és korrelációs.

replyToSessionId?: string

Tulajdonság értéke

string

scheduledEnqueueTimeUtc

Az a dátum és idő UTC-ben, amikor az üzenet le lesz iktatva. Ez a tulajdonság utc-ben adja vissza az időt; a tulajdonság beállításakor a megadott DateTime értéknek IS UTC-ben kell lennie. Ez az érték késleltetett üzenetküldésre használható. A későbbiekben egy adott időpontra küldött üzenetek késleltetésére használható. Az üzenet lekérdezési ideje nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer lekéri, de a tényleges küldési idő az üzenetsor számítási feladatától és állapotától függ.

scheduledEnqueueTimeUtc?: Date

Tulajdonság értéke

Date

sessionId

Egy munkamenet-tudatos entitás munkamenet-azonosítója. A maximális hossz 128 karakter. A munkamenet-tudatos entitások esetében 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é teszik a pontos sorrendben történő feldolgozást és a demultiplexinget. A munkamenet-nem tudó entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket. üzenet-munkamenetek.

sessionId?: string

Tulajdonság értéke

string

subject

Az alkalmazásspecifikus címke. Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított formátumban jelezze az üzenet célját a fogadónak. divat, hasonló egy e-mail tárgysor. A hozzárendelt AMQP tulajdonság "subject".

subject?: string

Tulajdonság értéke

string

timeToLive

Az üzenet ideje az élő értékre. Ez az érték az a relatív időtartam, amely után az üzenet lejár, kezdve attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet, amint az enqueuedTimeUtcrögzítette. 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ű timeToLive érték nem lehet hosszabb az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosul. Lásd: Lejárati.

timeToLive?: number

Tulajdonság értéke

number

to

A "címzett" cím. Ez a tulajdonság az útválasztási forgatókönyvekben való jövőbeli használatra van fenntartva, és jelenleg maga a közvetítő figyelmen kívül hagyja. Az alkalmazások ezt az értéket a szabályalapú automatikus továbbítási láncolás forgatókönyvekben használhatják az üzenet kívánt logikai célhelyének jelzésére.

to?: string

Tulajdonság értéke

string