MessagesEnqueueOptionalParams interface

Paquet:

@azure/storage-queue

Paramètres facultatifs.

Extends

RequestOptionsBase

Propriétés

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
customHeaders	sera appliqué avant l’envoi de la demande.
messageTimeToLive	Optionnel. Spécifie l’intervalle de temps de vie pour le message, en secondes. Avant la version 2017-07-29, la durée maximale de vie autorisée est de 7 jours. Pour la version 2017-07-29 ou ultérieure, la durée maximale de vie peut être n’importe quel nombre positif, ainsi que -1 indiquant que le message n’expire pas. Si ce paramètre est omis, la durée de vie par défaut est de 7 jours.
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.
visibilityTimeout	Optionnel. Si elle est spécifiée, la demande doit être effectuée à l’aide d’une version x-ms-2011-08-18 ou ultérieure. Si elle n’est pas spécifiée, la valeur par défaut est 0. Spécifie la nouvelle valeur de délai d’expiration de visibilité, en secondes, par rapport à l’heure du serveur. La nouvelle valeur doit être supérieure ou égale à 0 et ne peut pas être supérieure à 7 jours. Le délai de visibilité d’un message ne peut pas être défini sur une valeur ultérieure à l’heure d’expiration. visibilitytimeout doit être défini sur une valeur inférieure à la valeur de durée de vie.

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

messageTimeToLive

Optionnel. Spécifie l’intervalle de temps de vie pour le message, en secondes. Avant la version 2017-07-29, la durée maximale de vie autorisée est de 7 jours. Pour la version 2017-07-29 ou ultérieure, la durée maximale de vie peut être n’importe quel nombre positif, ainsi que -1 indiquant que le message n’expire pas. Si ce paramètre est omis, la durée de vie par défaut est de 7 jours.

messageTimeToLive?: 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

visibilityTimeout

Optionnel. Si elle est spécifiée, la demande doit être effectuée à l’aide d’une version x-ms-2011-08-18 ou ultérieure. Si elle n’est pas spécifiée, la valeur par défaut est 0. Spécifie la nouvelle valeur de délai d’expiration de visibilité, en secondes, par rapport à l’heure du serveur. La nouvelle valeur doit être supérieure ou égale à 0 et ne peut pas être supérieure à 7 jours. Le délai de visibilité d’un message ne peut pas être défini sur une valeur ultérieure à l’heure d’expiration. visibilitytimeout doit être défini sur une valeur inférieure à la valeur de durée de vie.

visibilityTimeout?: number

Valeur de propriété

number