Partager via

QueueReceiveMessageOptions interface

  • Référence
Paquet:
@azure/storage-queue

Options pour configurer l’opération receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Propriétés héritées

numberOfMessages

facultatif. Une valeur entière différente de zéro qui spécifie le nombre de messages à récupérer de la file d'attente, avec un maximum de 32. Si le nombre de messages est inférieur, tous les messages visibles sont retournés. Par défaut, cette opération ne récupère qu'un seul message de la file d'attente.
requestId

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

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

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

facultatif. Spécifie la nouvelle valeur du délai de visibilité, en secondes, par rapport au temps 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 d'expiration de la visibilité d'un message peut être défini à une valeur ultérieure au délai d'expiration.

Détails de la propriété héritée

numberOfMessages

facultatif. Une valeur entière différente de zéro qui spécifie le nombre de messages à récupérer de la file d'attente, avec un maximum de 32. Si le nombre de messages est inférieur, tous les messages visibles sont retournés. Par défaut, cette opération ne récupère qu'un seul message de la file d'attente.

numberOfMessages?: number

Valeur de propriété

number

Hérité deMessagesDequeueOptionalParams.numberOfMessages

requestId

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

requestId?: string

Valeur de propriété

string

Hérité deMessagesDequeueOptionalParams.requestId

timeoutInSeconds

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

timeoutInSeconds?: number

Valeur de propriété

number

Hérité deMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité deCommonOptions.tracingOptions

visibilityTimeout

facultatif. Spécifie la nouvelle valeur du délai de visibilité, en secondes, par rapport au temps 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 d'expiration de la visibilité d'un message peut être défini à une valeur ultérieure au délai d'expiration.

visibilityTimeout?: number

Valeur de propriété

number

Hérité deMessagesDequeueOptionalParams.visibilityTimeout