QueuePeekMessagesOptions interface

Pacchetto:

@azure/storage-queue

Opzioni per configurare l'operazione di <xref:QueueClient.peekMessages>

Extends

MessagesPeekOptionalParams

Proprietà

abortSignal	Segnale che può essere usato per interrompere le richieste.
customHeaders	verrà applicato prima dell'invio della richiesta.
numberOfMessages	Opzionale. Valore intero diverso da zero che specifica il numero di messaggi da recuperare dalla coda, fino a un massimo di 32. Se meno sono visibili, vengono restituiti i messaggi visibili. Per impostazione predefinita, un singolo messaggio viene recuperato dalla coda con questa operazione.
onDownloadProgress	Callback che viene attivato all'avanzamento del download.
onUploadProgress	Callback che viene attivato al momento dell'avanzamento del caricamento.
requestId	Fornisce un valore opaco generato dal client con un limite di caratteri di 1 KB registrato nei log di analisi quando la registrazione dell'analisi dell'archiviazione è abilitata.
serializerOptions	Opzioni per eseguire l'override del comportamento di analisi/compilazione XML.
shouldDeserialize	Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
timeout	Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata una AbortError.
timeoutInSeconds	Il parametro timeout è espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni del servizio di accodamento.
tracingContext	Traccia: contesto usato durante la creazione di intervalli.
tracingOptions	Opzioni per configurare gli intervalli creati quando la traccia è abilitata.

Dettagli proprietà

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

customHeaders

verrà applicato prima dell'invio della richiesta.

customHeaders?: [key: string]: string

Valore della proprietà

[key: string]: string

numberOfMessages

Opzionale. Valore intero diverso da zero che specifica il numero di messaggi da recuperare dalla coda, fino a un massimo di 32. Se meno sono visibili, vengono restituiti i messaggi visibili. Per impostazione predefinita, un singolo messaggio viene recuperato dalla coda con questa operazione.

numberOfMessages?: number

Valore della proprietà

number

onDownloadProgress

Callback che viene attivato all'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback che viene attivato al momento dell'avanzamento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

requestId

Fornisce un valore opaco generato dal client con un limite di caratteri di 1 KB registrato nei log di analisi quando la registrazione dell'analisi dell'archiviazione è abilitata.

requestId?: string

Valore della proprietà

string

serializerOptions

Opzioni per eseguire l'override del comportamento di analisi/compilazione XML.

serializerOptions?: SerializerOptions

Valore della proprietà

SerializerOptions

shouldDeserialize

Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.

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

Valore della proprietà

boolean | (response: HttpOperationResponse) => boolean

timeout

Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata una AbortError.

timeout?: number

Valore della proprietà

number

timeoutInSeconds

Il parametro timeout è espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni del servizio di accodamento.

timeoutInSeconds?: number

Valore della proprietà

number

tracingContext

Traccia: contesto usato durante la creazione di intervalli.

tracingContext?: Context

Valore della proprietà

Context

tracingOptions

Opzioni per configurare gli intervalli creati quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions