QueueReceiveMessageOptions interface

  • Riferimento
Pacchetto:
@azure/storage-queue

Opzioni per configurare 'operazione receiveMessages

Extends

MessagesDequeueOptionalParams,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.
visibilityTimeout

Opzionale. Specifica il nuovo valore di timeout di visibilità, espresso in secondi, rispetto al tempo del server. Il valore predefinito è 30 secondi. Un valore specificato deve essere maggiore o uguale a 1 secondo e non può essere maggiore di 7 giorni o superiore a 2 ore nelle versioni del protocollo REST precedenti alla versione 2011-08-18. Il timeout di visibilità di un messaggio può essere impostato su un valore successivo alla scadenza.

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 daMessagesDequeueOptionalParams.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 daMessagesDequeueOptionalParams.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 daMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

ereditato daCommonOptions.tracingOptions

visibilityTimeout

Opzionale. Specifica il nuovo valore di timeout di visibilità, espresso in secondi, rispetto al tempo del server. Il valore predefinito è 30 secondi. Un valore specificato deve essere maggiore o uguale a 1 secondo e non può essere maggiore di 7 giorni o superiore a 2 ore nelle versioni del protocollo REST precedenti alla versione 2011-08-18. Il timeout di visibilità di un messaggio può essere impostato su un valore successivo alla scadenza.

visibilityTimeout?: number

Valore della proprietà

number

Ereditato daMessagesDequeueOptionalParams.visibilityTimeout