QueuePeekMessagesOptions interface

Pacchetto:

@azure/storage-queue

Opzioni per configurare 'operazione di peekMessages

Extends

MessagesPeekOptionalParams,CommonOptions

Proprietà

abortSignal

Implementazione dell'interfaccia AbortSignalLike per segnalare la richiesta di annullare l'operazione. Ad esempio, usare il @azure/abort-controller per creare un AbortSignal.

Proprietà ereditate

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.
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.
timeoutInSeconds	Il parametro timeout è espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni del servizio di accodamento.
tracingOptions	Opzioni per configurare gli intervalli creati quando la traccia è abilitata.

Dettagli proprietà

abortSignal

Implementazione dell'interfaccia AbortSignalLike per segnalare la richiesta di annullare l'operazione. Ad esempio, usare il @azure/abort-controller per creare un AbortSignal.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Dettagli proprietà ereditate

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

Ereditato daMessagesPeekOptionalParams.numberOfMessages

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

ereditato daMessagesPeekOptionalParams.requestId

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

ereditato daMessagesPeekOptionalParams.timeoutInSeconds

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

ereditato daCommonOptions.tracingOptions