CreateQueueOptions interface
Představuje nastavitelné možnosti ve frontě.
- Extends
Vlastnosti
authorization |
Autorizační pravidla ve frontě |
auto |
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 |
availability |
Stav dostupnosti entity zasílání zpráv. |
dead |
Pokud je povolená a platnost zprávy vyprší, služba Service Bus přesune zprávu z fronty do dílčí fronty nedoručených zpráv. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z fronty. Nastavitelné pouze při vytváření fronty. |
default |
V závislosti na tom, jestli je povoleno nedoručené zprávy, se zpráva automaticky přesune do dílčí fronty nedoručených zpráv nebo se odstraní, pokud byla ve frontě uložena déle, než je zadaná doba. Tato hodnota je přepsána hodnotou TTL zadanou ve zprávě, pouze pokud je hodnota TTL zprávy menší než hodnota TTL nastavená ve frontě. Tato hodnota je po vytvoření fronty neměnná. 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 |
duplicate |
Určuje časové období, během kterého služba Service Bus detekuje duplikaci zpráv. 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 |
enable |
Určuje, jestli mají být povolené dávkové operace. |
enable |
Určuje, jestli jsou ve frontě povolené expresní entity. |
enable |
Určuje, jestli má být fronta rozdělená na oddíly. |
forward |
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 . |
forward |
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 . |
lock |
Určuje dobu v sekundách, během které by měla být zpráva uzamčena pro zpracování příjemcem. Po uplynutí této doby se zpráva odemkne a bude ji možné použít dalšímu příjemci. (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 |
max |
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. |
max |
Maximální velikost zpráv odeslaných do této fronty v kilobajtech (Dá se konfigurovat jenom pro obor názvů Služby Service Bus úrovně Premium.) |
max |
Určuje maximální velikost fronty v megabajtech. Jakýkoli pokus o zařazení zprávy do fronty, který způsobí, že fronta překročí tuto hodnotu, se nezdaří. |
requires |
Pokud je povoleno, téma zjistí duplicitní zprávy v časovém rozsahu určeném vlastností DuplicateDetectionHistoryTimeWindow. Nastavitelné pouze při vytváření fronty. |
requires |
Pokud je nastavená hodnota true, bude fronta používat relace a bude se podporovat pouze SessionReceiver. Fronty pracující s relacemi se prostřednictvím rozhraní REST nepodporují. Nastavitelné pouze při vytváření fronty. |
status | Stav entity zasílání zpráv. |
user |
Uživatel zadal informace o metadatech přidružené k frontě. 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
abort |
Signál, který lze použít k přerušení požadavků. |
on |
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. |
request |
Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci |
serializer |
Možnosti přepsání chování serializace/de-serializace. |
tracing |
Možnosti použité při povoleném trasování. |
Podrobnosti vlastnosti
authorizationRules
Autorizační pravidla ve frontě
authorizationRules?: AuthorizationRule[]
Hodnota 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
deadLetteringOnMessageExpiration
Pokud je povolená a platnost zprávy vyprší, služba Service Bus přesune zprávu z fronty do dílčí fronty nedoručených zpráv. Pokud je tato možnost zakázaná, zpráva se trvale odstraní z fronty. Nastavitelné pouze při vytváření fronty.
deadLetteringOnMessageExpiration?: boolean
Hodnota vlastnosti
boolean
defaultMessageTimeToLive
V závislosti na tom, jestli je povoleno nedoručené zprávy, se zpráva automaticky přesune do dílčí fronty nedoručených zpráv nebo se odstraní, pokud byla ve frontě uložena déle, než je zadaná doba. Tato hodnota je přepsána hodnotou TTL zadanou ve zprávě, pouze pokud je hodnota TTL zprávy menší než hodnota TTL nastavená ve frontě. Tato hodnota je po vytvoření fronty neměnná. 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
duplicateDetectionHistoryTimeWindow
Určuje časové období, během kterého služba Service Bus detekuje duplikaci zpráv. 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
duplicateDetectionHistoryTimeWindow?: string
Hodnota vlastnosti
string
enableBatchedOperations
Určuje, jestli mají být povolené dávkové operace.
enableBatchedOperations?: boolean
Hodnota vlastnosti
boolean
enableExpress
Určuje, jestli jsou ve frontě povolené expresní entity.
enableExpress?: boolean
Hodnota vlastnosti
boolean
enablePartitioning
Určuje, jestli má být fronta rozdělená na oddíly.
enablePartitioning?: 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
Určuje dobu v sekundách, během které by měla být zpráva uzamčena pro zpracování příjemcem. Po uplynutí této doby se zpráva odemkne a bude ji možné použít dalšímu příjemci. (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
maxMessageSizeInKilobytes
Maximální velikost zpráv odeslaných do této fronty v kilobajtech
(Dá se konfigurovat jenom pro obor názvů Služby Service Bus úrovně Premium.)
maxMessageSizeInKilobytes?: number
Hodnota vlastnosti
number
maxSizeInMegabytes
Určuje maximální velikost fronty v megabajtech. Jakýkoli pokus o zařazení zprávy do fronty, který způsobí, že fronta překročí tuto hodnotu, se nezdaří.
maxSizeInMegabytes?: number
Hodnota vlastnosti
number
requiresDuplicateDetection
Pokud je povoleno, téma zjistí duplicitní zprávy v časovém rozsahu určeném vlastností DuplicateDetectionHistoryTimeWindow. Nastavitelné pouze při vytváření fronty.
requiresDuplicateDetection?: boolean
Hodnota vlastnosti
boolean
requiresSession
Pokud je nastavená hodnota true, bude fronta používat relace a bude se podporovat pouze SessionReceiver. Fronty pracující s relacemi se prostřednictvím rozhraní REST nepodporují. Nastavitelné pouze při vytváření fronty.
requiresSession?: boolean
Hodnota vlastnosti
boolean
status
userMetadata
Uživatel zadal informace o metadatech přidružené k frontě. 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
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
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
Zděděno zOperationOptions.requestOptions
serializerOptions
Možnosti přepsání chování serializace/de-serializace.
serializerOptions?: SerializerOptions
Hodnota vlastnosti
Zděděno zOperationOptions.serializerOptions
tracingOptions
Možnosti použité při povoleném trasování.
tracingOptions?: OperationTracingOptions
Hodnota vlastnosti
Zděděno zOperationOptions.tracingOptions