ServiceBusMessage interface

Balíček:

@azure/service-bus

Popisuje zprávu, která se má odeslat do služby Service Bus.

Vlastnosti

applicationProperties	Vlastnosti specifické pro aplikaci, které lze použít pro vlastní metadata zpráv.
body	Text zprávy, který musí být odeslán nebo přijat. Pokud aplikace, která zprávu obdrží, tuto sadu SDK nepoužívá, převeďte datovou část textu na pole bajtů nebo vyrovnávací paměť pro lepší kompatibilitu mezi jazyky.
contentType	Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem ve formátu RFC2045 oddílu 5, například "application/json".
correlationId	Identifikátor korelace, který aplikaci umožňuje zadat kontext zprávy pro účely korelace, například odrážející Id zprávy, na kterou se odpovídá. Viz směrování zpráv a korelace.
messageId	Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část. Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolená.
partitionKey	Klíč oddílu pro odeslání zprávy do dělené entity. Maximální délka je 128 znaků. Pro dělené entitynastavení této hodnoty umožňuje přiřazovat související zprávy do stejného interního oddílu, aby bylo správně zaznamenáno pořadí odeslání. Oddíl je zvolen funkcí hash nad touto hodnotou a nelze ho vybrat přímo. U entit pracujících s relacemi přepíše tato hodnota vlastnost sessionId. U nedělených entit se klíč oddílu bude ignorovat.
replyTo	Adresa entity, na kterou se mají odesílat odpovědi. Tato volitelná hodnota a hodnota definovaná aplikací je 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 fronty nebo tématu, na kterou očekává odeslání odpovědi. Viz směrování zpráv a korelace.
replyToSessionId	Identifikátor relace, který rozšiřuje replyTo 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í zpráv a korelace.
scheduledEnqueueTimeUtc	Datum a čas ve standardu UTC, ve kterém se zpráva zapíše do fronty. Tato vlastnost vrátí čas ve standardu UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určená pro zpožděné odesílání zpráv. V budoucnu se využívá ke zpoždění odesílání zpráv do určitého času. Čas zařazení zprávy do fronty neznamená, že zpráva bude odeslána současně. Zařadí se do fronty, ale skutečný čas odeslání závisí na úloze fronty a jeho stavu.
sessionId	Identifikátor relace pro entitu pracující s relací. Maximální délka je 128 znaků. U entit pracujících s relacemi určuje tato hodnota definovaná aplikací přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému uzamčení a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nejsou v relaci, se tato hodnota ignoruje. relace zpráv.
subject	Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy příjemci ve standardizované. podobně jako řádek předmětu e-mailu. Mapovaná vlastnost AMQP je "subject".
timeToLive	Hodnota zprávy je čas naživu. Tato hodnota je relativní doba trvání, po které vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není nastaven explicitně, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota timeToLive na úrovni zpráv nemůže být delší než nastavení DefaultTimeToLive entity a v případě potřeby se bezobslužně upraví. 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časnosti je ignorována samotným zprostředkovatelem. Aplikace můžou tuto hodnotu použít v automatickém přeposílání scénářích, které označují zamýšlený logický cíl 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, který musí být odeslán nebo přijat. Pokud aplikace, která zprávu obdrží, tuto sadu SDK nepoužívá, převeďte datovou část textu na pole bajtů nebo vyrovnávací paměť pro lepší kompatibilitu mezi jazyky.

body: any

Hodnota vlastnosti

any

contentType

Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem ve formátu RFC2045 oddílu 5, například "application/json".

contentType?: string

Hodnota vlastnosti

string

correlationId

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

correlationId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

messageId

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

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

messageId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

partitionKey

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

• U entit pracujících s relacemi přepíše tato hodnota vlastnost sessionId.
• U nedělených entit se klíč oddílu bude ignorovat.

partitionKey?: string

Hodnota vlastnosti

string

replyTo

Adresa entity, na kterou se mají odesílat odpovědi. Tato volitelná hodnota a hodnota definovaná aplikací je 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 fronty nebo tématu, na kterou očekává odeslání odpovědi. Viz směrování zpráv a korelace.

replyTo?: string

Hodnota vlastnosti

string

replyToSessionId

Identifikátor relace, který rozšiřuje replyTo 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í zpráv a korelace.

replyToSessionId?: string

Hodnota vlastnosti

string

scheduledEnqueueTimeUtc

Datum a čas ve standardu UTC, ve kterém se zpráva zapíše do fronty. Tato vlastnost vrátí čas ve standardu UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určená pro zpožděné odesílání zpráv. V budoucnu se využívá ke zpoždění odesílání zpráv do určitého času. Čas zařazení zprávy do fronty neznamená, že zpráva bude odeslána současně. Zařadí se do fronty, ale skutečný čas odeslání závisí na úloze fronty a jeho stavu.

scheduledEnqueueTimeUtc?: Date

Hodnota vlastnosti

Date

sessionId

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

sessionId?: string

Hodnota vlastnosti

string

subject

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

subject?: string

Hodnota vlastnosti

string

timeToLive

Hodnota zprávy je čas naživu. Tato hodnota je relativní doba trvání, po které vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není nastaven explicitně, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota timeToLive na úrovni zpráv nemůže být delší než nastavení DefaultTimeToLive entity a v případě potřeby se bezobslužně upraví. 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časnosti je ignorována samotným zprostředkovatelem. Aplikace můžou tuto hodnotu použít v automatickém přeposílání scénářích, které označují zamýšlený logický cíl zprávy.

to?: string

Hodnota vlastnosti

string