QueuePeekMessagesOptions interface
Opties voor het configureren van peekMessages-bewerking
- Extends
Overgenomen eigenschappen
abort |
Signaal van een afgebroken controller. Kan worden gebruikt om zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken. |
custom |
wordt toegepast voordat de aanvraag wordt verzonden. |
number |
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. |
on |
Callback die wordt geactiveerd bij de voortgang van het downloaden. |
on |
Callback die wordt geactiveerd bij de uploadvoortgang. |
request |
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. |
serializer |
Opties voor het overschrijven van xml-parserings-/bouwgedrag. |
should |
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 |
timeout |
De parameter De time-out wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie. |
tracing |
Tracering: Context die wordt gebruikt bij het maken van spans. |
tracing |
Opties voor het configureren van spans die worden gemaakt wanneer tracering is ingeschakeld. |
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 vanMessagesPeekOptionalParams.abortSignal
customHeaders
wordt toegepast voordat de aanvraag wordt verzonden.
customHeaders?: {[key: string]: string}
Waarde van eigenschap
{[key: string]: string}
Overgenomen vanMessagesPeekOptionalParams.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 vanMessagesPeekOptionalParams.numberOfMessages
onDownloadProgress
Callback die wordt geactiveerd bij de voortgang van het downloaden.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
Overgenomen vanMessagesPeekOptionalParams.onDownloadProgress
onUploadProgress
Callback die wordt geactiveerd bij de uploadvoortgang.
onUploadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
Overgenomen vanMessagesPeekOptionalParams.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 vanMessagesPeekOptionalParams.requestId
serializerOptions
Opties voor het overschrijven van xml-parserings-/bouwgedrag.
serializerOptions?: SerializerOptions
Waarde van eigenschap
Overgenomen vanMessagesPeekOptionalParams.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 vanMessagesPeekOptionalParams.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 vanMessagesPeekOptionalParams.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 vanMessagesPeekOptionalParams.timeoutInSeconds
tracingContext
Tracering: Context die wordt gebruikt bij het maken van spans.
tracingContext?: Context
Waarde van eigenschap
Overgenomen vanMessagesPeekOptionalParams.tracingContext
tracingOptions
Opties voor het configureren van spans die worden gemaakt wanneer tracering is ingeschakeld.
tracingOptions?: OperationTracingOptions
Waarde van eigenschap
Overgenomen vanCommonOptions.tracingOptions