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 üzenettörzs. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbökké vagy pufferekké a jobb nyelvközi kompatibilitás érdekében.
contentType	Az üzenet tartalomtípusa. Opcionálisan leírja az üzenet hasznos adatait, az RFC2045 5. szakaszának formátumát követő leíróval, például "application/json".
correlationId	A korrelációs azonosító, amely lehetővé teszi az alkalmazás számára, hogy korreláció céljából kontextust adjon meg az üzenethez, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenetirányítás és korreláció.
messageId	Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és annak hasznos adatait. Megjegyzés: A nem egész egész számokat nem lehet megadni.
partitionKey	Az üzenet particionált entitásnak való küldéséhez használt partíciókulcs. A maximális hossz 128 karakter. Particionált entitások esetén 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. Munkamenet-felismerő entitások esetén a sessionId tulajdonság felülbírálja ezt az értéket. Nem particionált entitások esetén a rendszer figyelmen kívül hagyja a partíciókulcsot
replyTo	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ó.
replyToSessionId	A címmel kiegészített replyTo munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-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ó.
scheduledEnqueueTimeUtc	Az a dátum és időpont (UTC), amikor az üzenet be lesz iktatva. Ez a tulajdonság az időpontot (UTC) adja vissza; 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ó. Ez a funkció arra használható, hogy késleltetje az adott időpontra küldött üzeneteket a jövőben. Az üzenetbeiktatási idő nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer beké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	Munkamenet-felismerő entitás munkamenet-azonosítója. A maximális hossz 128 karakter. Munkamenet-felismerő 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 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 módon jelezze az üzenet célját a fogadónak. divat, hasonlóan az e-mail tárgysorához. A leképezett AMQP tulajdonság "subject".
timeToLive	Az üzenet élettartamának ideje. 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 a következőben enqueuedTimeUtcrö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ű timeToLive értékek nem lehetnek hosszabbak az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosulnak. Lásd: Lejárat.
to	A "címzett" cím. 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.

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 üzenettörzs. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbökké vagy pufferekké a jobb nyelvközi kompatibilitás érdekében.

body: any

Tulajdonság értéke

any

contentType

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

contentType?: string

Tulajdonság értéke

string

correlationId

A korrelációs azonosító, amely lehetővé teszi az alkalmazás számára, hogy korreláció céljából kontextust adjon meg az üzenethez, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenetirányítás és korreláció.

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 annak hasznos adatait.

Megjegyzés: A nem egész egész számokat nem lehet megadni.

messageId?: string | number | Buffer

Tulajdonság értéke

string | number | Buffer

partitionKey

Az üzenet particionált entitásnak való küldéséhez használt partíciókulcs. A maximális hossz 128 karakter. Particionált entitások esetén 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.

• Munkamenet-felismerő entitások esetén a sessionId tulajdonság felülbírálja ezt az értéket.
• Nem particionált entitások esetén a rendszer figyelmen kívül hagyja a partíciókulcsot

partitionKey?: string

Tulajdonság értéke

string

replyTo

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ó.

replyTo?: string

Tulajdonság értéke

string

replyToSessionId

A címmel kiegészített replyTo munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-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ó.

replyToSessionId?: string

Tulajdonság értéke

string

scheduledEnqueueTimeUtc

Az a dátum és időpont (UTC), amikor az üzenet be lesz iktatva. Ez a tulajdonság az időpontot (UTC) adja vissza; 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ó. Ez a funkció arra használható, hogy késleltetje az adott időpontra küldött üzeneteket a jövőben. Az üzenetbeiktatási idő nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer beké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

Munkamenet-felismerő entitás munkamenet-azonosítója. A maximális hossz 128 karakter. Munkamenet-felismerő 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 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 módon jelezze az üzenet célját a fogadónak. divat, hasonlóan az e-mail tárgysorához. A leképezett AMQP tulajdonság "subject".

subject?: string

Tulajdonság értéke

string

timeToLive

Az üzenet élettartamának ideje. 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 a következőben enqueuedTimeUtcrö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ű timeToLive értékek nem lehetnek hosszabbak az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosulnak. Lásd: Lejárat.

timeToLive?: number

Tulajdonság értéke

number

to

A "címzett" cím. 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.

to?: string

Tulajdonság értéke

string