QueuePeekMessagesOptions interface

Pakket:

@azure/storage-queue

Opties voor het configureren van <xref:QueueClient.peekMessages> bewerking

Uitbreiding

MessagesPeekOptionalParams

Eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
customHeaders	wordt toegepast voordat de aanvraag wordt verzonden.
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.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij het uploaden.
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.
serializerOptions	Opties voor het overschrijven van XML-parserings-/bouwgedrag.
shouldDeserialize	Of httpOperationResponse al dan niet 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 er een AbortError gegenereerd.
timeoutInSeconds	De time-outparameter 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 periodes die zijn gemaakt wanneer tracering is ingeschakeld.

Eigenschapdetails

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

customHeaders

wordt toegepast voordat de aanvraag wordt verzonden.

customHeaders?: [key: string]: string

Waarde van eigenschap

[key: string]: string

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

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

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

serializerOptions

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

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

shouldDeserialize

Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

timeout

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

timeout?: number

Waarde van eigenschap

number

timeoutInSeconds

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

timeoutInSeconds?: number

Waarde van eigenschap

number

tracingContext

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

tracingContext?: Context

Waarde van eigenschap

Context

tracingOptions

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

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions