QueueReceiveMessageOptions interface

Opties voor het configureren van de receiveMessages-bewerking

Extends

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.

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. Met deze bewerking wordt standaard één bericht opgehaald uit de wachtrij.

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onUploadProgress

Callback die wordt geactiveerd bij de uploadvoortgang.

requestId

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

serializerOptions

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

shouldDeserialize

Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet 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.

timeoutInSeconds

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

tracingContext

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

tracingOptions

Opties voor het configureren van spans die worden gemaakt wanneer tracering is ingeschakeld.

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 zichtbaarheidstime-out van een bericht kan worden ingesteld op een waarde die later is dan de verlooptijd.

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

Overgenomen vanMessagesDequeueOptionalParams.abortSignal

customHeaders

wordt toegepast voordat de aanvraag wordt verzonden.

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

Waarde van eigenschap

{[key: string]: string}

Overgenomen vanMessagesDequeueOptionalParams.customHeaders

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. Met deze bewerking wordt standaard één bericht opgehaald uit de wachtrij.

numberOfMessages?: number

Waarde van eigenschap

number

Overgenomen vanMessagesDequeueOptionalParams.numberOfMessages

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

Overgenomen vanMessagesDequeueOptionalParams.onDownloadProgress

onUploadProgress

Callback die wordt geactiveerd bij de uploadvoortgang.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

Overgenomen vanMessagesDequeueOptionalParams.onUploadProgress

requestId

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

requestId?: string

Waarde van eigenschap

string

Overgenomen vanMessagesDequeueOptionalParams.requestId

serializerOptions

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

serializerOptions?: SerializerOptions

Waarde van eigenschap

Overgenomen vanMessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

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

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

Overgenomen vanMessagesDequeueOptionalParams.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 vanMessagesDequeueOptionalParams.timeout

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

Overgenomen vanMessagesDequeueOptionalParams.timeoutInSeconds

tracingContext

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

tracingContext?: Context

Waarde van eigenschap

@azure/core-tracing.Context

Overgenomen vanMessagesDequeueOptionalParams.tracingContext

tracingOptions

Opties voor het configureren van spans die worden gemaakt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

Overgenomen vanCommonOptions.tracingOptions

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 zichtbaarheidstime-out van een bericht kan worden ingesteld op een waarde die later is dan de verlooptijd.

visibilityTimeout?: number

Waarde van eigenschap

number

Overgenomen vanMessagesDequeueOptionalParams.visibilityTimeout