QueueReceiveMessageOptions interface

Paquet:

@azure/storage-queue

Options de configuration de l’opération de <xref:QueueClient.receiveMessages>

Extends

MessagesDequeueOptionalParams

Propriétés

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
customHeaders	sera appliqué avant l’envoi de la demande.
numberOfMessages	Optionnel. Valeur entière différente de zéro qui spécifie le nombre de messages à récupérer à partir de la file d’attente, jusqu’à un maximum de 32. Si moins de messages sont visibles, les messages visibles sont retournés. Par défaut, un message unique est récupéré à partir de la file d’attente avec cette opération.
onDownloadProgress	Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress	Rappel qui se déclenche lors de la progression du chargement.
requestId	Fournit une valeur opaque générée par le client avec une limite de caractères de 1 Ko enregistrée dans les journaux d’activité d’analyse lorsque la journalisation d’analytique de stockage est activée.
serializerOptions	Options permettant de remplacer le comportement d’analyse/génération XML.
shouldDeserialize	Indique si HttpOperationResponse doit être désérialisé ou non. S’il n’est pas défini, httpOperationResponse doit être désérialisé.
timeout	Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée.
timeoutInSeconds	Le paramètre de délai d’attente est exprimé en secondes. Pour plus d’informations, consultez Définition des délais d’attente pour les opérations de service de file d’attente.
tracingContext	Suivi : contexte utilisé lors de la création d’étendues.
tracingOptions	Options de configuration des étendues créées lorsque le suivi est activé.
visibilityTimeout	Optionnel. Spécifie la nouvelle valeur de délai d’expiration de visibilité, en secondes, par rapport à l’heure du serveur. La valeur par défaut est de 30 secondes. Une valeur spécifiée doit être supérieure ou égale à 1 seconde et ne peut pas être supérieure à 7 jours, ou supérieure à 2 heures sur les versions du protocole REST antérieures à la version 2011-08-18. Le délai de visibilité d’un message peut être défini sur une valeur ultérieure à l’heure d’expiration.

Détails de la propriété

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

customHeaders

sera appliqué avant l’envoi de la demande.

customHeaders?: [key: string]: string

Valeur de propriété

[key: string]: string

numberOfMessages

Optionnel. Valeur entière différente de zéro qui spécifie le nombre de messages à récupérer à partir de la file d’attente, jusqu’à un maximum de 32. Si moins de messages sont visibles, les messages visibles sont retournés. Par défaut, un message unique est récupéré à partir de la file d’attente avec cette opération.

numberOfMessages?: number

Valeur de propriété

number

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

requestId

Fournit une valeur opaque générée par le client avec une limite de caractères de 1 Ko enregistrée dans les journaux d’activité d’analyse lorsque la journalisation d’analytique de stockage est activée.

requestId?: string

Valeur de propriété

string

serializerOptions

Options permettant de remplacer le comportement d’analyse/génération XML.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

shouldDeserialize

Indique si HttpOperationResponse doit être désérialisé ou non. S’il n’est pas défini, httpOperationResponse doit être désérialisé.

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

Valeur de propriété

boolean | (response: HttpOperationResponse) => boolean

timeout

Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée.

timeout?: number

Valeur de propriété

number

timeoutInSeconds

Le paramètre de délai d’attente est exprimé en secondes. Pour plus d’informations, consultez Définition des délais d’attente pour les opérations de service de file d’attente.

timeoutInSeconds?: number

Valeur de propriété

number

tracingContext

Suivi : contexte utilisé lors de la création d’étendues.

tracingContext?: Context

Valeur de propriété

Context

tracingOptions

Options de configuration des étendues créées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

visibilityTimeout

Optionnel. Spécifie la nouvelle valeur de délai d’expiration de visibilité, en secondes, par rapport à l’heure du serveur. La valeur par défaut est de 30 secondes. Une valeur spécifiée doit être supérieure ou égale à 1 seconde et ne peut pas être supérieure à 7 jours, ou supérieure à 2 heures sur les versions du protocole REST antérieures à la version 2011-08-18. Le délai de visibilité d’un message peut être défini sur une valeur ultérieure à l’heure d’expiration.

visibilityTimeout?: number

Valeur de propriété

number