QueueReceiveMessageOptions interface

Pakket:

@azure/storage-queue

Opties voor het configureren van receiveMessages bewerking

Uitbreiding

MessagesDequeueOptionalParams,CommonOptions

Eigenschappen

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

Overgenomen eigenschappen

numberOfMessages	Facultatief. Een niet-nul geheel getal dat het aantal berichten aangeeft dat uit de wachtrij moet worden opgehaald, maximaal 32. Als er minder zichtbaar zijn, worden de zichtbare berichten geretourneerd. Standaard wordt met deze bewerking één bericht opgehaald uit de wachtrij.
requestId	Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kB die wordt vastgelegd in de analyselogboeken wanneer logboekregistratie van opslaganalyse is ingeschakeld.
timeoutInSeconds	De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.
tracingOptions	Opties voor het configureren van periodes die zijn gemaakt wanneer tracering is ingeschakeld.
visibilityTimeout	Facultatief. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van servertijd. De standaardwaarde is 30 seconden. Een opgegeven waarde moet groter zijn dan of gelijk zijn aan 1 seconde en mag niet groter zijn dan 7 dagen of groter dan 2 uur op REST-protocolversies vóór versie 2011-08-18. De time-out voor zichtbaarheid van een bericht kan worden ingesteld op een waarde later dan de verlooptijd.

Eigenschapdetails

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

Details van overgenomen eigenschap

numberOfMessages

Facultatief. Een niet-nul geheel getal dat het aantal berichten aangeeft dat uit de wachtrij moet worden opgehaald, maximaal 32. Als er minder zichtbaar zijn, worden de zichtbare berichten geretourneerd. Standaard wordt met deze bewerking één bericht opgehaald uit de wachtrij.

numberOfMessages?: number

Waarde van eigenschap

number

overgenomen vanMessagesDequeueOptionalParams.numberOfMessages

requestId

Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kB die wordt vastgelegd in de analyselogboeken wanneer logboekregistratie van opslaganalyse is ingeschakeld.

requestId?: string

Waarde van eigenschap

string

overgenomen vanMessagesDequeueOptionalParams.requestId

timeoutInSeconds

De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.

timeoutInSeconds?: number

Waarde van eigenschap

number

overgenomen vanMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

Opties voor het configureren van periodes die zijn gemaakt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen vanCommonOptions.tracingOptions-

visibilityTimeout

Facultatief. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van servertijd. De standaardwaarde is 30 seconden. Een opgegeven waarde moet groter zijn dan of gelijk zijn aan 1 seconde en mag niet groter zijn dan 7 dagen of groter dan 2 uur op REST-protocolversies vóór versie 2011-08-18. De time-out voor zichtbaarheid van een bericht kan worden ingesteld op een waarde later dan de verlooptijd.

visibilityTimeout?: number

Waarde van eigenschap

number

overgenomen vanMessagesDequeueOptionalParams.visibilityTimeout