CreateSubscriptionOptions interface

Balíček:

@azure/service-bus

Představuje nastavitelné možnosti předplatného.

Extends

OperationOptions

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 o formě zprávy. Nastavitelné pouze při vytváření tématu.
deadLetteringOnMessageExpiration	Pokud je povolená a platnost zprávy vyprší, služba Service Bus přesune zprávu z fronty do pod fronty nedoručených zpráv předplatného. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z hlavní fronty předplatného. Nastavitelné pouze při vytváření předplatného.
defaultMessageTimeToLive	Určuje, jak dlouho je zpráva v předplatném. V závislosti na tom, jestli je povoleno nedoručené zprávy, se zpráva, jejíž hodnota TTL vypršela, přesune do předplatného přidružené funkce DeadLtterQueue nebo se trvale odstraní. To je třeba zadat ve formátu doby trvání ISO-8601, například "PT1M" po dobu 1 minuty, "PT5S" po dobu 5 sekund. Další informace o formátu doby trvání ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions	Představuje možnosti pro vytvoření výchozího pravidla pro předplatné.
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řeposílat nedoručené zprávy. Například absolutní zadání adresy URL by bylo z formuláře. 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řeposílat. Například absolutní zadání adresy URL by bylo z formuláře. sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	Výchozí doba trvání zámku se použije u předplatných, která nedefinují dobu trvání zámku. (Pokud jsou relace povolené, platí tato doba trvání zámku pro relace, nikoli pro zprávy.) To je třeba zadat ve formátu doby trvání ISO-8601, například "PT1M" po dobu 1 minuty, "PT5S" po dobu 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 ještě není vyřešen, se přesune do pod fronty nedoručených zpráv.
requiresSession	Pokud je nastavená hodnota true, předplatné bude používat relace a bude podporováno 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.
userMetadata	Uživatel poskytl informace o metadatech přidružených 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.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
onResponse	Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.
requestOptions	Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
serializerOptions	Možnosti přepsání chování serializace/de-serializace.
tracingOptions	Možnosti použité při povoleném trasování.

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 o formě zprávy. Nastavitelné pouze při vytváření tématu.

deadLetteringOnFilterEvaluationExceptions?: boolean

Hodnota vlastnosti

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

Hodnota vlastnosti

boolean

defaultMessageTimeToLive

Určuje, jak dlouho je zpráva v předplatném. V závislosti na tom, jestli je povoleno nedoručené zprávy, se zpráva, jejíž hodnota TTL vypršela, přesune do předplatného přidružené funkce DeadLtterQueue nebo se trvale odstraní. To je třeba zadat ve formátu doby trvání ISO-8601, například "PT1M" po dobu 1 minuty, "PT5S" po dobu 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

defaultRuleOptions

Představuje možnosti pro vytvoření výchozího pravidla pro předplatné.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

Hodnota vlastnosti

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: 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řeposílat nedoručené zprávy. Například absolutní zadání adresy URL by bylo z formuláře. 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řeposílat. Například absolutní zadání adresy URL by bylo z formuláře. 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 u předplatných, která nedefinují dobu trvání zámku. (Pokud jsou relace povolené, platí tato doba trvání zámku pro relace, nikoli pro zprávy.)

To je třeba zadat ve formátu doby trvání ISO-8601, například "PT1M" po dobu 1 minuty, "PT5S" po dobu 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 ještě není vyřešen, 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 používat relace a bude podporováno 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

userMetadata

Uživatel poskytl informace o metadatech přidružených 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

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno zOperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

RawResponseCallback

Zděděno zOperationOptions.onResponse

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

OperationRequestOptions

Zděděno zOperationOptions.requestOptions

serializerOptions

Možnosti přepsání chování serializace/de-serializace.

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

Zděděno zOperationOptions.serializerOptions

tracingOptions

Možnosti použité při povoleném trasování.

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno zOperationOptions.tracingOptions