SubscriptionProperties interface

Balíček:

@azure/service-bus

Představuje vstup pro updateSubscription.

Vlastnosti

autoDeleteOnIdle	Maximální doba nečinnosti před odstraněním entity. Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund. Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	Stav dostupnosti entity zasílání zpráv.
deadLetteringOnFilterEvaluationExceptions	Určuje, jak Služba Service Bus zpracovává zprávu, která během vyhodnocování filtru odběru způsobí výjimku. Pokud je hodnota nastavená na true, zpráva, která způsobila výjimku, se přesune do dílčí fronty nedoručených zpráv odběru. Jinak se zahodí. Ve výchozím nastavení je tento parametr nastaven na hodnotu true, což uživateli umožňuje prozkoumat příčinu výjimky. Může k tomu dojít v důsledku chybné zprávy nebo některých nesprávných předpokladů ve filtru týkajících se tvaru zprávy. Nastavitelné pouze při vytváření tématu.
deadLetteringOnMessageExpiration	Pokud je povolená a platnost zprávy vyprší, Service Bus přesune zprávu z fronty do dílčí fronty nedoručených zpráv odběru. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z hlavní fronty odběru. Nastavitelné pouze při vytváření předplatného.
defaultMessageTimeToLive	Určuje, jak dlouho zpráva je v odběru. Na základě toho, jestli je povoleno nedoručování zpráv, se zpráva, jejíž hodnota TTL vypršela, přesune do složky DeadLtterQueue přidružené k předplatnému nebo se trvale odstraní. Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund. Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations	Určuje, jestli mají být povolené dávkové operace.
forwardDeadLetteredMessagesTo	Absolutní adresa URL nebo název fronty nebo tématu, na které se mají předávat nedoručené zprávy. Například absolutní vstup adresy URL by byl ve formátu . sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	Absolutní adresa URL nebo název fronty nebo tématu, na které se mají zprávy předávat. Například absolutní vstup adresy URL by byl ve formátu . sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	Výchozí doba trvání zámku se použije na předplatná, která nedefinují dobu uzamčení. (Pokud jsou povoleny relace, platí tato doba uzamčení pro relace a ne pro zprávy.) Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund. Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	Maximální počet doručení zpráv, po jejichž uplynutí, pokud se stále nevyrovná, se přesune do pod fronty nedoručených zpráv.
requiresSession	Pokud je nastavená hodnota true, předplatné bude podporovat pouze relaci a bude se podporovat pouze SessionReceiver. Předplatné s podporou relací se prostřednictvím REST nepodporuje. Nastavitelné pouze při vytváření předplatného.
status	Stav entity zasílání zpráv.
subscriptionName	Název předplatného
topicName	Název tématu
userMetadata	Uživatel poskytl informace o metadatech přidružené k předplatnému. Slouží k určení textového obsahu, jako jsou značky, popisky atd. Hodnota nesmí překročit 1024 bajtů zakódovaných v utf-8.

Podrobnosti vlastnosti

autoDeleteOnIdle

Maximální doba nečinnosti před odstraněním entity. Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund.

Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle: string

Hodnota vlastnosti

string

availabilityStatus

Stav dostupnosti entity zasílání zpráv.

availabilityStatus?: EntityAvailabilityStatus

Hodnota vlastnosti

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Určuje, jak Služba Service Bus zpracovává zprávu, která během vyhodnocování filtru odběru způsobí výjimku. Pokud je hodnota nastavená na true, zpráva, která způsobila výjimku, se přesune do dílčí fronty nedoručených zpráv odběru. Jinak se zahodí. Ve výchozím nastavení je tento parametr nastaven na hodnotu true, což uživateli umožňuje prozkoumat příčinu výjimky. Může k tomu dojít v důsledku chybné zprávy nebo některých nesprávných předpokladů ve filtru týkajících se tvaru zprávy. Nastavitelné pouze při vytváření tématu.

deadLetteringOnFilterEvaluationExceptions: boolean

Hodnota vlastnosti

boolean

deadLetteringOnMessageExpiration

Pokud je povolená a platnost zprávy vyprší, Service Bus přesune zprávu z fronty do dílčí fronty nedoručených zpráv odběru. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z hlavní fronty odběru. Nastavitelné pouze při vytváření předplatného.

deadLetteringOnMessageExpiration: boolean

Hodnota vlastnosti

boolean

defaultMessageTimeToLive

Určuje, jak dlouho zpráva je v odběru. Na základě toho, jestli je povoleno nedoručování zpráv, se zpráva, jejíž hodnota TTL vypršela, přesune do složky DeadLtterQueue přidružené k předplatnému nebo se trvale odstraní. Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund.

Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive: string

Hodnota vlastnosti

string

enableBatchedOperations

Určuje, jestli mají být povolené dávkové operace.

enableBatchedOperations: boolean

Hodnota vlastnosti

boolean

forwardDeadLetteredMessagesTo

Absolutní adresa URL nebo název fronty nebo tématu, na které se mají předávat nedoručené zprávy. Například absolutní vstup adresy URL by byl ve formátu . sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Hodnota vlastnosti

string

forwardTo

Absolutní adresa URL nebo název fronty nebo tématu, na které se mají zprávy předávat. Například absolutní vstup adresy URL by byl ve formátu . sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Hodnota vlastnosti

string

lockDuration

Výchozí doba trvání zámku se použije na předplatná, která nedefinují dobu uzamčení. (Pokud jsou povoleny relace, platí tato doba uzamčení pro relace a ne pro zprávy.)

Tato hodnota je určena ve formátu doby trvání ISO-8601, například PT1M na 1 minutu, PT5S na 5 sekund.

Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration: string

Hodnota vlastnosti

string

maxDeliveryCount

Maximální počet doručení zpráv, po jejichž uplynutí, pokud se stále nevyrovná, se přesune do pod fronty nedoručených zpráv.

maxDeliveryCount: number

Hodnota vlastnosti

number

requiresSession

Pokud je nastavená hodnota true, předplatné bude podporovat pouze relaci a bude se podporovat pouze SessionReceiver. Předplatné s podporou relací se prostřednictvím REST nepodporuje. Nastavitelné pouze při vytváření předplatného.

requiresSession: boolean

Hodnota vlastnosti

boolean

status

Stav entity zasílání zpráv.

status: EntityStatus

Hodnota vlastnosti

EntityStatus

subscriptionName

Název předplatného

subscriptionName: string

Hodnota vlastnosti

string

topicName

Název tématu

topicName: string

Hodnota vlastnosti

string

userMetadata

Uživatel poskytl informace o metadatech přidružené k předplatnému. Slouží k určení textového obsahu, jako jsou značky, popisky atd. Hodnota nesmí překročit 1024 bajtů zakódovaných v utf-8.

userMetadata?: string

Hodnota vlastnosti

string