QueueReceiveMessageOptions interface

Balíček:

@azure/storage-queue

Možnosti konfigurace operace receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Vlastnosti

abortSignal

Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.

Zděděné vlastnosti

numberOfMessages	Volitelný. Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají načíst z fronty, maximálně 32. Pokud je jich méně, vrátí se viditelné zprávy. Ve výchozím nastavení se jedna zpráva načte z fronty s touto operací.
requestId	Poskytuje hodnotu vygenerovanou klientem s 1kB limitem znaků, který je zaznamenán v analytických protokolech při povolení protokolování analýzy úložiště.
timeoutInSeconds	Parametr časového limitu se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace frontové služby.
tracingOptions	Možnosti konfigurace rozsahů vytvořených při povolení trasování
visibilityTimeout	Volitelný. Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Výchozí hodnota je 30 sekund. Zadaná hodnota musí být větší než nebo rovna 1 sekundě a nesmí být větší než 7 dní nebo větší než 2 hodiny ve verzích protokolu REST před verzí 2011-08-18. Časový limit viditelnosti zprávy je možné nastavit na hodnotu později, než je čas vypršení platnosti.

Podrobnosti vlastnosti

abortSignal

Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Podrobnosti zděděných vlastností

numberOfMessages

Volitelný. Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají načíst z fronty, maximálně 32. Pokud je jich méně, vrátí se viditelné zprávy. Ve výchozím nastavení se jedna zpráva načte z fronty s touto operací.

numberOfMessages?: number

Hodnota vlastnosti

number

zděděno zMessagesDequeueOptionalParams.numberOfMessages

requestId

Poskytuje hodnotu vygenerovanou klientem s 1kB limitem znaků, který je zaznamenán v analytických protokolech při povolení protokolování analýzy úložiště.

requestId?: string

Hodnota vlastnosti

string

zděděno zMessagesDequeueOptionalParams.requestId

timeoutInSeconds

Parametr časového limitu se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace frontové služby.

timeoutInSeconds?: number

Hodnota vlastnosti

number

zděděno zMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

Možnosti konfigurace rozsahů vytvořených při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno zCommonOptions.tracingOptions

visibilityTimeout

Volitelný. Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Výchozí hodnota je 30 sekund. Zadaná hodnota musí být větší než nebo rovna 1 sekundě a nesmí být větší než 7 dní nebo větší než 2 hodiny ve verzích protokolu REST před verzí 2011-08-18. Časový limit viditelnosti zprávy je možné nastavit na hodnotu později, než je čas vypršení platnosti.

visibilityTimeout?: number

Hodnota vlastnosti

number

zděděno zMessagesDequeueOptionalParams.visibilityTimeout