MessagesDequeueOptionalParams interface

Pakket:

@azure/storage-queue

Optionele parameters.

Extends

RequestOptionsBase

Eigenschappen

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

Overgenomen eigenschappen

abortSignal	Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.
customHeaders	wordt toegepast voordat de aanvraag wordt verzonden.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij de voortgang van het uploaden.
serializerOptions	Opties voor het overschrijven van XML-parserings-/bouwgedrag.
shouldDeserialize	Of het HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet de HttpOperationResponse worden gedeserialiseerd.
timeout	Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt een AbortError gegenereerd.
tracingContext	Tracering: Context die wordt gebruikt bij het maken van spans.

Eigenschapdetails

numberOfMessages

Optioneel. Een niet-nul gehele waarde die het aantal berichten aangeeft dat uit de wachtrij moet worden opgehaald, tot een maximum van 32. Als er minder zichtbaar zijn, worden de zichtbare berichten geretourneerd. Standaard wordt met deze bewerking één bericht uit de wachtrij opgehaald.

numberOfMessages?: number

Waarde van eigenschap

number

requestId

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

requestId?: string

Waarde van eigenschap

string

timeoutInSeconds

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

timeoutInSeconds?: number

Waarde van eigenschap

number

visibilityTimeout

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

visibilityTimeout?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

Overgenomen van RequestOptionsBase.abortSignal

customHeaders

wordt toegepast voordat de aanvraag wordt verzonden.

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

Waarde van eigenschap

{[key: string]: string}

Overgenomen van RequestOptionsBase.customHeaders

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

Overgenomen van RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback die wordt geactiveerd bij de voortgang van het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

Overgenomen van RequestOptionsBase.onUploadProgress

serializerOptions

Opties voor het overschrijven van XML-parserings-/bouwgedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

Overgenomen van RequestOptionsBase.serializerOptions

shouldDeserialize

Of het HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet de HttpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

Overgenomen van RequestOptionsBase.shouldDeserialize

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt een AbortError gegenereerd.

timeout?: number

Waarde van eigenschap

number

Overgenomen van RequestOptionsBase.timeout

tracingContext

Tracering: Context die wordt gebruikt bij het maken van spans.

tracingContext?: Context

Waarde van eigenschap

@azure/core-tracing.Context

Overgenomen van RequestOptionsBase.tracingContext