MessagesDequeueOptionalParams interface

Balíček:

@azure/storage-queue

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

numberOfMessages	Nepovinný parametr. Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají načíst z fronty, maximálně 32. Pokud je viditelných méně, viditelné zprávy se vrátí. Ve výchozím nastavení se z fronty pomocí této operace načte jedna zpráva.
requestId	Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem 1 kB počtu znaků, který je zaznamenán v analytických protokolech, když je protokolování analýzy úložiště povolené.
timeoutInSeconds	Parametr časového limitu je vyjádřen v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace frontové služby.
visibilityTimeout	Nepovinný parametr. 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ší nebo rovna 1 sekundě a nesmí být delší než 7 dnů nebo delší než 2 hodiny ve verzích protokolu REST starších než 2011-08-18. Časový limit viditelnosti zprávy je možné nastavit na hodnotu později, než je doba vypršení platnosti.

Zděděné vlastnosti

abortSignal	Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.
customHeaders	se použije před odesláním žádosti.
onDownloadProgress	Zpětné volání, které se aktivuje při průběhu stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
serializerOptions	Možnosti přepsání chování při analýze nebo sestavování XML
shouldDeserialize	Zda httpOperationResponse má být deserializován. Pokud to není definováno, měl by být httpOperationResponse deserializován.
timeout	Počet milisekund, které může požadavek trvat před automatickým ukončením. Pokud je žádost ukončena, AbortError vyvolá se příkaz .
tracingContext	Trasování: Kontext použitý při vytváření spans.

Podrobnosti vlastnosti

numberOfMessages

Nepovinný parametr. Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají načíst z fronty, maximálně 32. Pokud je viditelných méně, viditelné zprávy se vrátí. Ve výchozím nastavení se z fronty pomocí této operace načte jedna zpráva.

numberOfMessages?: number

Hodnota vlastnosti

number

requestId

Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem 1 kB počtu znaků, který je zaznamenán v analytických protokolech, když je protokolování analýzy úložiště povolené.

requestId?: string

Hodnota vlastnosti

string

timeoutInSeconds

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

timeoutInSeconds?: number

Hodnota vlastnosti

number

visibilityTimeout

Nepovinný parametr. 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ší nebo rovna 1 sekundě a nesmí být delší než 7 dnů nebo delší než 2 hodiny ve verzích protokolu REST starších než 2011-08-18. Časový limit viditelnosti zprávy je možné nastavit na hodnotu později, než je doba vypršení platnosti.

visibilityTimeout?: number

Hodnota vlastnosti

number

Podrobnosti zděděných vlastností

abortSignal

Signál přerušení kontroleru. Dá se použít k přerušení odesílání síťového požadavku i čekání na odpověď.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z RequestOptionsBase.abortSignal

customHeaders

se použije před odesláním žádosti.

customHeaders?: {[key: string]: string}

Hodnota vlastnosti

{[key: string]: string}

Zděděno z RequestOptionsBase.customHeaders

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onDownloadProgress

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onUploadProgress

serializerOptions

Možnosti přepsání chování při analýze nebo sestavování XML

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

Zděděno z RequestOptionsBase.serializerOptions

shouldDeserialize

Zda httpOperationResponse má být deserializován. Pokud to není definováno, měl by být httpOperationResponse deserializován.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

Zděděno z RequestOptionsBase.shouldDeserialize

timeout

Počet milisekund, které může požadavek trvat před automatickým ukončením. Pokud je žádost ukončena, AbortError vyvolá se příkaz .

timeout?: number

Hodnota vlastnosti

number

Zděděno z RequestOptionsBase.timeout

tracingContext

Trasování: Kontext použitý při vytváření spans.

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

Zděděno z RequestOptionsBase.tracingContext