MessagesEnqueueOptionalParams interface

Pakket:

@azure/storage-queue

Optionele parameters.

Extends

RequestOptionsBase

Eigenschappen

messageTimeToLive	Optioneel. Hiermee geeft u het time-to-live-interval voor het bericht op, in seconden. Vóór versie 2017-07-29 is de maximale time-to-live toegestaan 7 dagen. Voor versie 2017-07-29 of hoger kan de maximale time-to-live elk positief getal zijn, evenals -1 dat aangeeft dat het bericht niet verloopt. Als deze parameter wordt weggelaten, is de standaard time-to-live 7 dagen.
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.
timeoutInSeconds	De parameter De time-out wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.
visibilityTimeout	Optioneel. Indien opgegeven, moet de aanvraag worden gedaan met een x-ms-versie van 2011-08-18 of hoger. Als u dit niet opgeeft, is de standaardwaarde 0. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van de servertijd. De nieuwe waarde moet groter dan of gelijk zijn aan 0 en mag niet langer zijn dan 7 dagen. De zichtbaarheidstime-out van een bericht kan niet worden ingesteld op een waarde die later is dan de verlooptijd. visibilitytimeout moet worden ingesteld op een waarde die kleiner is dan de time-to-live-waarde.

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 uploadvoortgang.
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.
tracingContext	Tracering: Context die wordt gebruikt bij het maken van spans.

Eigenschapdetails

messageTimeToLive

Optioneel. Hiermee geeft u het time-to-live-interval voor het bericht op, in seconden. Vóór versie 2017-07-29 is de maximale time-to-live toegestaan 7 dagen. Voor versie 2017-07-29 of hoger kan de maximale time-to-live elk positief getal zijn, evenals -1 dat aangeeft dat het bericht niet verloopt. Als deze parameter wordt weggelaten, is de standaard time-to-live 7 dagen.

messageTimeToLive?: number

Waarde van eigenschap

number

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

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. Indien opgegeven, moet de aanvraag worden gedaan met een x-ms-versie van 2011-08-18 of hoger. Als u dit niet opgeeft, is de standaardwaarde 0. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van de servertijd. De nieuwe waarde moet groter dan of gelijk zijn aan 0 en mag niet langer zijn dan 7 dagen. De zichtbaarheidstime-out van een bericht kan niet worden ingesteld op een waarde die later is dan de verlooptijd. visibilitytimeout moet worden ingesteld op een waarde die kleiner is dan de time-to-live-waarde.

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 uploadvoortgang.

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 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 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