CreateSubscriptionOptions interface

Balíček:

@azure/service-bus

Představuje nastavené možnosti v předplatném.

Extends

OperationOptions

Vlastnosti

autoDeleteOnIdle	Maximální doba nečinnosti před odstraněním entity To se má 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
availabilityStatus	Stav dostupnosti entity zasílání zpráv
deadLetteringOnFilterEvaluationExceptions	Určuje, jak Service Bus zpracovává zprávu, která způsobí výjimku během vyhodnocení filtru odběru. 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 předplatného. 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 nastat z nesprávně formátované zprávy nebo některých nesprávných předpokladů provedených ve filtru o formě zprávy. Lze nastavit pouze při vytváření tématu.
deadLetteringOnMessageExpiration	Pokud je tato zpráva povolená a vyprší její platnost, služba Service Bus přesune zprávu z fronty do dílčí fronty odběru nedoručených zpráv. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z hlavní fronty odběru. Lze nastavit pouze při vytváření předplatného.
defaultMessageTimeToLive	Určuje, jak dlouho se zpráva nachází v odběru. Na základě toho, jestli je povolené nedoručené dopisování, se zpráva, jejíž hodnota TTL vypršela, přesune buď do přidruženého předplatného DeadLtterQueue, nebo trvale odstraní. To se má 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 vytvoření výchozího pravidla pro předplatné.
enableBatchedOperations	Určuje, jestli mají být povoleny dávkové operace.
forwardDeadLetteredMessagesTo	Absolutní adresa URL nebo název fronty nebo tématu, na které se zprávy nedoručené dopisy přeposílají. Například absolutní vstup adresy URL by byl sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name> formuláře.
forwardTo	Absolutní adresa URL nebo název fronty nebo tématu, na které mají být zprávy přeposílané. Například absolutní vstup adresy URL by byl sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name> formuláře.
lockDuration	Výchozí doba uzamčení se použije u předplatných, která nedefinují dobu uzamčení. (Pokud jsou relace povoleny, je tato doba uzamčení použitelná pro relace a ne pro zprávy.) To se má 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 kterých je stále neurovnaný, se přesune do dílčí fronty nedoručených zpráv.
requiresSession	Pokud je nastavená hodnota true, předplatné bude mít informace o relaci a bude podporováno pouze SessionReceiver. Předplatné s podporou relací se nepodporuje prostřednictvím rest. Lze nastavit pouze při vytváření předplatného.
status	Stav entity zasílání zpráv
userMetadata	Uživatel zadal 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ů kó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 se volat 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í serializace/de-serializace chování.
tracingOptions	Možnosti používané při povolení trasování

Podrobnosti vlastnosti

autoDeleteOnIdle

Maximální doba nečinnosti před odstraněním entity To se má 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

autoDeleteOnIdle?: string

Hodnota vlastnosti

string

availabilityStatus

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

availabilityStatus?: EntityAvailabilityStatus

Hodnota vlastnosti

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Určuje, jak Service Bus zpracovává zprávu, která způsobí výjimku během vyhodnocení filtru odběru. 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 předplatného. 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 nastat z nesprávně formátované zprávy nebo některých nesprávných předpokladů provedených ve filtru o formě zprávy. Lze nastavit pouze při vytváření tématu.

deadLetteringOnFilterEvaluationExceptions?: boolean

Hodnota vlastnosti

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration?: boolean

Hodnota vlastnosti

boolean

defaultMessageTimeToLive

Určuje, jak dlouho se zpráva nachází v odběru. Na základě toho, jestli je povolené nedoručené dopisování, se zpráva, jejíž hodnota TTL vypršela, přesune buď do přidruženého předplatného DeadLtterQueue, nebo trvale odstraní. To se má 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 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 povoleny dávkové operace.

enableBatchedOperations?: boolean

Hodnota vlastnosti

boolean

forwardDeadLetteredMessagesTo

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

forwardDeadLetteredMessagesTo?: string

Hodnota vlastnosti

string

forwardTo

Absolutní adresa URL nebo název fronty nebo tématu, na které mají být zprávy přeposílané. Například absolutní vstup adresy URL by byl sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name> formuláře.

forwardTo?: string

Hodnota vlastnosti

string

lockDuration

Výchozí doba uzamčení se použije u předplatných, která nedefinují dobu uzamčení. (Pokud jsou relace povoleny, je tato doba uzamčení použitelná pro relace a ne pro zprávy.)

To se má 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 kterých je stále neurovnaný, se přesune do dílčí fronty nedoručených zpráv.

maxDeliveryCount?: number

Hodnota vlastnosti

number

requiresSession

Pokud je nastavená hodnota true, předplatné bude mít informace o relaci a bude podporováno pouze SessionReceiver. Předplatné s podporou relací se nepodporuje prostřednictvím rest. Lze nastavit 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 zadal 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ů kó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 se volat 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í serializace/de-serializace chování.

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

zděděno zOperationOptions.serializerOptions

tracingOptions

Možnosti používané při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno zOperationOptions.tracingOptions