QueuePeekMessagesOptions interface

Balíček:

@azure/storage-queue

Možnosti konfigurace operace peekMessages

Extends

MessagesPeekOptionalParams,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 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 průběhu stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
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é.
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 .
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.
tracingContext	Trasování: Kontext použitý při vytváření spans.
tracingOptions	Možnosti konfigurace rozsahů vytvořené při povolení trasování

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ávPeekOptionalParams.abortSignal

customHeaders

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

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

Hodnota vlastnosti

{[key: string]: string}

Zděděno zezprávPeekOptionalParams.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 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ávPeekOptionalParams.numberOfMessages

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 zezprávPeekOptionalParams.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 zezprávPeekOptionalParams.onUploadProgress

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

Zděděno zMessagesPeekOptionalParams.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 zMessagesPeekOptionalParams.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 zezprávPeekOptionalParams.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 zMessagesPeekOptionalParams.timeout

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

Zděděno zezprávPeekOptionalParams.timeoutInSeconds

tracingContext

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

tracingContext?: Context

Hodnota vlastnosti

@azure/core-tracing.Context

Zděděno zMessagesPeekOptionalParams.tracingContext

tracingOptions

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

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno zCommonOptions.tracingOptions