MessagesDequeueOptionalParams interface
Paramètres facultatifs.
- Extends
Propriétés
| number |
Optional. 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. |
| request |
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. |
| timeout |
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. |
| visibility |
Optional. 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. |
Propriétés héritées
| tracing |
Options de configuration des étendues créées lorsque le suivi est activé. |
Détails de la propriété
numberOfMessages
Optional. 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
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
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
visibilityTimeout
Optional. 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
Détails de la propriété héritée
tracingOptions
Options de configuration des étendues créées lorsque le suivi est activé.
tracingOptions?: OperationTracingOptions
Valeur de propriété
hérité deCommonOptions.tracingOptions