QueueReceiveMessageOptions interface

Balíček:

@azure/storage-queue

Možnosti konfigurace operace receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

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.
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 jich 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.
onDownloadProgress	Zpětné volání, které se aktivuje při stahování.
onUploadProgress	Zpětné volání, které se aktivuje při nahrávání.
requestId	Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu znaků 1 kB, která se zaznamenává v protokolech analýzy, když je povolené protokolování analýzy úložiště.
serializerOptions	Možnosti přepsání chování při analýze nebo sestavování XML
shouldDeserialize	Zda HttpOperationResponse by měla být deserializována. Pokud je nedefinováno, httpOperationResponse by měla být deserializována.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, AbortError vyvolá se .
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.
tracingContext	Trasování: Kontext použitý při vytváření rozsahů.
tracingOptions	Možnosti konfigurace rozsahů vytvořených při povoleném trasování
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 ve verzích protokolu REST starších než 2011-08-18 nesmí být delší než 7 dnů nebo delší než 2 hodiny. Časový limit viditelnosti zprávy je možné nastavit na hodnotu pozdější, než je čas vypršení platnosti.

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 zezprávDequeueOptionalParams.abortSignal

customHeaders

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

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

Hodnota vlastnosti

{[key: string]: string}

Zděděno zezprávDequeueOptionalParams.customHeaders

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 jich 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

Zděděno zezprávDequeueOptionalParams.numberOfMessages

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno zezprávDequeueOptionalParams.onDownloadProgress

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno zezprávDequeueOptionalParams.onUploadProgress

requestId

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

requestId?: string

Hodnota vlastnosti

string

Zděděno zezprávDequeueOptionalParams.requestId

serializerOptions

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

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

Zděděno zMessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

Zda HttpOperationResponse by měla být deserializována. Pokud je nedefinováno, httpOperationResponse by měla být deserializována.

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

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

Zděděno zezprávDequeueOptionalParams.shouldDeserialize

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí. Pokud je žádost ukončena, AbortError vyvolá se .

timeout?: number

Hodnota vlastnosti

number

Zděděno zezprávDequeueOptionalParams.timeout

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 zezprávDequeueOptionalParams.timeoutInSeconds

tracingContext

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

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

Zděděno zezprávDequeueOptionalParams.tracingContext

tracingOptions

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

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno zCommonOptions.tracingOptions

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

visibilityTimeout?: number

Hodnota vlastnosti

number

Zděděno zezprávDequeueOptionalParams.visibilityTimeout