ServiceBusMessage interface

Balíček:

@azure/service-bus

Popisuje zprávu, která se má odeslat službě Service Bus.

Vlastnosti

applicationProperties	Vlastnosti specifické pro aplikaci, které lze použít pro vlastní metadata zpráv.
body	Text zprávy, kterou je potřeba odeslat nebo která je přijata. Pokud aplikace přijímající zprávu tuto sadu SDK nepoužívá, převeďte datovou část těla na pole bajtů nebo vyrovnávací paměť, aby se zlepšila kompatibilita mezi jazyky.
contentType	Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem za formátem RFC2045, Oddíl 5, například "application/json".
correlationId	Identifikátor korelace, který umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odráží MessageId zprávy, na kterou odpovídáte. Viz Směrování a korelace zpráv.
messageId	Identifikátor zprávy je hodnota definovaná aplikací, která jedinečně identifikuje zprávu a její datovou část. Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolena.
partitionKey	Klíč oddílu pro odeslání zprávy do rozdělené entity. Maximální délka je 128 znaků. U dělených entit umožňuje nastavení této hodnoty přiřazovat související zprávy ke stejnému internímu oddílu, aby bylo pořadí odeslání správně zaznamenáno. Oddíl je zvolen hashovací funkcí nad touto hodnotou a nelze ho zvolit přímo. U entit pracujících s relacemi sessionId vlastnost tuto hodnotu přepíše. U nedělených entit se klíč oddílu ignoruje.
replyTo	Adresa entity, na kterou chcete odesílat odpovědi. Tato volitelná a aplikacemi definovaná hodnota představuje standardní způsob vyjádření cesty odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu na absolutní nebo relativní cestu k frontě nebo tématu, do které očekává odeslání odpovědi. Viz Směrování a korelace zpráv.
replyToSessionId	Identifikátor relace, který replyTo rozšiřuje adresu. Maximální délka je 128 znaků. Tato hodnota rozšiřuje informace ReplyTo a určuje, které Id relace se má nastavit pro odpověď při odeslání do entity odpovědi. Viz Směrování a korelace zpráv.
scheduledEnqueueTimeUtc	Datum a čas ve standardu UTC, kdy bude zpráva zapsána do fronty. Tato vlastnost vrátí čas v UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určena pro zpožděné odesílání zpráv. Používá se ke zpoždění odesílání zpráv do určitého času v budoucnu. Čas vytvoření fronty zpráv neznamená, že zpráva bude odeslána ve stejnou dobu. Zařadí se do fronty, ale skutečná doba odeslání závisí na zatížení fronty a jejím stavu.
sessionId	Identifikátor relace pro entitu pracující s relacemi. Maximální délka je 128 znaků. U entit pracujících s relacemi tato hodnota definovaná aplikací určuje přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému zamykání a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nevědí o relaci, je tato hodnota ignorována. Relace zpráv.
subject	Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy pro příjemce ve standardizované. podobně jako u řádku předmětu e-mailu. Namapovaná vlastnost AMQP je "subject".
timeToLive	Hodnota "time to live" zprávy. Tato hodnota je relativní doba trvání, po jejímž uplynutí vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zaznamenáno v enqueuedTimeUtc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota na úrovni timeToLive zprávy nemůže být delší než nastavení DefaultTimeToLive entity, a pokud ano, upraví se bezobslužně. Viz Vypršení platnosti.
to	Adresa "komu". Tato vlastnost je vyhrazena pro budoucí použití ve scénářích směrování a v současné době je ignorována samotným zprostředkovatelem. Aplikace mohou tuto hodnotu použít ve scénářích automatického řetězení řízeného pravidly k označení zamýšleného logického cíle zprávy.

Podrobnosti vlastnosti

applicationProperties

Vlastnosti specifické pro aplikaci, které lze použít pro vlastní metadata zpráv.

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

Hodnota vlastnosti

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

body

Text zprávy, kterou je potřeba odeslat nebo která je přijata. Pokud aplikace přijímající zprávu tuto sadu SDK nepoužívá, převeďte datovou část těla na pole bajtů nebo vyrovnávací paměť, aby se zlepšila kompatibilita mezi jazyky.

body: any

Hodnota vlastnosti

any

contentType

Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem za formátem RFC2045, Oddíl 5, například "application/json".

contentType?: string

Hodnota vlastnosti

string

correlationId

Identifikátor korelace, který umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odráží MessageId zprávy, na kterou odpovídáte. Viz Směrování a korelace zpráv.

correlationId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

messageId

Identifikátor zprávy je hodnota definovaná aplikací, která jedinečně identifikuje zprávu a její datovou část.

Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolena.

messageId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

partitionKey

Klíč oddílu pro odeslání zprávy do rozdělené entity. Maximální délka je 128 znaků. U dělených entit umožňuje nastavení této hodnoty přiřazovat související zprávy ke stejnému internímu oddílu, aby bylo pořadí odeslání správně zaznamenáno. Oddíl je zvolen hashovací funkcí nad touto hodnotou a nelze ho zvolit přímo.

• U entit pracujících s relacemi sessionId vlastnost tuto hodnotu přepíše.
• U nedělených entit se klíč oddílu ignoruje.

partitionKey?: string

Hodnota vlastnosti

string

replyTo

Adresa entity, na kterou chcete odesílat odpovědi. Tato volitelná a aplikacemi definovaná hodnota představuje standardní způsob vyjádření cesty odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu na absolutní nebo relativní cestu k frontě nebo tématu, do které očekává odeslání odpovědi. Viz Směrování a korelace zpráv.

replyTo?: string

Hodnota vlastnosti

string

replyToSessionId

Identifikátor relace, který replyTo rozšiřuje adresu. Maximální délka je 128 znaků. Tato hodnota rozšiřuje informace ReplyTo a určuje, které Id relace se má nastavit pro odpověď při odeslání do entity odpovědi. Viz Směrování a korelace zpráv.

replyToSessionId?: string

Hodnota vlastnosti

string

scheduledEnqueueTimeUtc

Datum a čas ve standardu UTC, kdy bude zpráva zapsána do fronty. Tato vlastnost vrátí čas v UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určena pro zpožděné odesílání zpráv. Používá se ke zpoždění odesílání zpráv do určitého času v budoucnu. Čas vytvoření fronty zpráv neznamená, že zpráva bude odeslána ve stejnou dobu. Zařadí se do fronty, ale skutečná doba odeslání závisí na zatížení fronty a jejím stavu.

scheduledEnqueueTimeUtc?: Date

Hodnota vlastnosti

Date

sessionId

Identifikátor relace pro entitu pracující s relacemi. Maximální délka je 128 znaků. U entit pracujících s relacemi tato hodnota definovaná aplikací určuje přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému zamykání a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nevědí o relaci, je tato hodnota ignorována. Relace zpráv.

sessionId?: string

Hodnota vlastnosti

string

subject

Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy pro příjemce ve standardizované. podobně jako u řádku předmětu e-mailu. Namapovaná vlastnost AMQP je "subject".

subject?: string

Hodnota vlastnosti

string

timeToLive

Hodnota "time to live" zprávy. Tato hodnota je relativní doba trvání, po jejímž uplynutí vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zaznamenáno v enqueuedTimeUtc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota na úrovni timeToLive zprávy nemůže být delší než nastavení DefaultTimeToLive entity, a pokud ano, upraví se bezobslužně. Viz Vypršení platnosti.

timeToLive?: number

Hodnota vlastnosti

number

to

Adresa "komu". Tato vlastnost je vyhrazena pro budoucí použití ve scénářích směrování a v současné době je ignorována samotným zprostředkovatelem. Aplikace mohou tuto hodnotu použít ve scénářích automatického řetězení řízeného pravidly k označení zamýšleného logického cíle zprávy.

to?: string

Hodnota vlastnosti

string