Partager via

QueueProperties interface

  • Référence
Paquet:
@azure/service-bus

Représente l’entrée de updateQueue.

Propriétés

authorizationRules

Règles d’autorisation dans la file d’attente
autoDeleteOnIdle

Durée d’inactivité maximale avant la suppression de l’entité. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

État de disponibilité de l’entité de messagerie.
deadLetteringOnMessageExpiration

S’il est activé et qu’un message expire, Service Bus déplace le message de la file d’attente dans la sous-file d’attente de lettres mortes de la file d’attente. Si cette option est désactivée, le message est définitivement supprimé de la file d’attente. Settable uniquement au moment de la création de la file d’attente.
defaultMessageTimeToLive

Selon que DeadLettering est activé, un message est automatiquement déplacé vers la sous-file d’attente de lettres mortes ou supprimé s’il a été stocké dans la file d’attente depuis plus longtemps que l’heure spécifiée. Cette valeur est remplacée par une durée de vie spécifiée sur le message si et uniquement si la durée de vie du message est inférieure à la durée de vie définie dans la file d’attente. Cette valeur est immuable une fois la file d’attente créée. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow

Spécifie l’intervalle de temps pendant lequel Service Bus détecte la duplication de messages. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations

Spécifie si les opérations par lots doivent être autorisées.
enableExpress

Spécifie si les entités express sont activées sur la file d’attente.
enablePartitioning

Spécifie si la file d’attente doit être partitionnée.
forwardDeadLetteredMessagesTo

L’URL absolue ou le nom de la file d’attente ou de la rubrique vers laquelle les messages de lettres mortes doivent être transférés. Par exemple, une entrée d’URL absolue serait de la forme sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages doivent être transférés. Par exemple, une entrée d’URL absolue serait de la forme sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

Détermine la durée en secondes pendant laquelle un message doit être verrouillé pour traitement par un récepteur. Après cette période, le message est déverrouillé et disponible pour la consommation par le destinataire suivant. (Si les sessions sont activées, cette durée de verrouillage s’applique aux sessions et non aux messages.)

Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

Nombre maximal de messages après quoi, s’il n’est toujours pas réglé, est déplacé vers la sous-file d’attente de lettres mortes.
maxMessageSizeInKilobytes

Taille maximale des messages en kilo-octets pour les messages envoyés à cette file d’attente.

Non applicable si la version de service « 2017-04 » est choisie lors de la création du ServiceBusAdministrationClient.
maxSizeInMegabytes

Spécifie la taille maximale de file d’attente en mégaoctets. Toute tentative de mise en file d’attente d’un message qui entraîne l’échec de la file d’attente dépasse cette valeur.
name

Nom de la file d’attente
requiresDuplicateDetection

Si cette option est activée, la rubrique détecte les messages en double dans l’intervalle de temps spécifié par la propriété DuplicateDetectionHistoryTimeWindow. Settable uniquement au moment de la création de la file d’attente.
requiresSession

Si la valeur est true, la file d’attente prend en charge la session et seule SessionReceiver est prise en charge. Les files d’attente prenant en charge les sessions ne sont pas prises en charge via REST. Settable uniquement au moment de la création de la file d’attente.
status

État de l’entité de messagerie.
userMetadata

L’utilisateur a fourni des informations de métadonnées associées à la file d’attente. Permet de spécifier du contenu textuel tel que des étiquettes, des étiquettes, etc. La valeur ne doit pas dépasser 1024 octets encodés en utf-8.

Détails de la propriété

authorizationRules

Règles d’autorisation dans la file d’attente

authorizationRules?: AuthorizationRule[]

Valeur de propriété

AuthorizationRule[]

autoDeleteOnIdle

Durée d’inactivité maximale avant la suppression de l’entité. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle: string

Valeur de propriété

string

availabilityStatus

État de disponibilité de l’entité de messagerie.

availabilityStatus: EntityAvailabilityStatus

Valeur de propriété

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

S’il est activé et qu’un message expire, Service Bus déplace le message de la file d’attente dans la sous-file d’attente de lettres mortes de la file d’attente. Si cette option est désactivée, le message est définitivement supprimé de la file d’attente. Settable uniquement au moment de la création de la file d’attente.

deadLetteringOnMessageExpiration: boolean

Valeur de propriété

boolean

defaultMessageTimeToLive

Selon que DeadLettering est activé, un message est automatiquement déplacé vers la sous-file d’attente de lettres mortes ou supprimé s’il a été stocké dans la file d’attente depuis plus longtemps que l’heure spécifiée. Cette valeur est remplacée par une durée de vie spécifiée sur le message si et uniquement si la durée de vie du message est inférieure à la durée de vie définie dans la file d’attente. Cette valeur est immuable une fois la file d’attente créée. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive: string

Valeur de propriété

string

duplicateDetectionHistoryTimeWindow

Spécifie l’intervalle de temps pendant lequel Service Bus détecte la duplication de messages. Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow: string

Valeur de propriété

string

enableBatchedOperations

Spécifie si les opérations par lots doivent être autorisées.

enableBatchedOperations: boolean

Valeur de propriété

boolean

enableExpress

Spécifie si les entités express sont activées sur la file d’attente.

enableExpress: boolean

Valeur de propriété

boolean

enablePartitioning

Spécifie si la file d’attente doit être partitionnée.

enablePartitioning: boolean

Valeur de propriété

boolean

forwardDeadLetteredMessagesTo

L’URL absolue ou le nom de la file d’attente ou de la rubrique vers laquelle les messages de lettres mortes doivent être transférés. Par exemple, une entrée d’URL absolue serait de la forme sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Valeur de propriété

string

forwardTo

URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages doivent être transférés. Par exemple, une entrée d’URL absolue serait de la forme sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Valeur de propriété

string

lockDuration

Détermine la durée en secondes pendant laquelle un message doit être verrouillé pour traitement par un récepteur. Après cette période, le message est déverrouillé et disponible pour la consommation par le destinataire suivant. (Si les sessions sont activées, cette durée de verrouillage s’applique aux sessions et non aux messages.)

Il doit être spécifié dans un format de durée ISO-8601 tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

Plus d’informations sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration: string

Valeur de propriété

string

maxDeliveryCount

Nombre maximal de messages après quoi, s’il n’est toujours pas réglé, est déplacé vers la sous-file d’attente de lettres mortes.

maxDeliveryCount: number

Valeur de propriété

number

maxMessageSizeInKilobytes

Taille maximale des messages en kilo-octets pour les messages envoyés à cette file d’attente.

Non applicable si la version de service « 2017-04 » est choisie lors de la création du ServiceBusAdministrationClient.

maxMessageSizeInKilobytes?: number

Valeur de propriété

number

maxSizeInMegabytes

Spécifie la taille maximale de file d’attente en mégaoctets. Toute tentative de mise en file d’attente d’un message qui entraîne l’échec de la file d’attente dépasse cette valeur.

maxSizeInMegabytes: number

Valeur de propriété

number

name

Nom de la file d’attente

name: string

Valeur de propriété

string

requiresDuplicateDetection

Si cette option est activée, la rubrique détecte les messages en double dans l’intervalle de temps spécifié par la propriété DuplicateDetectionHistoryTimeWindow. Settable uniquement au moment de la création de la file d’attente.

requiresDuplicateDetection: boolean

Valeur de propriété

boolean

requiresSession

Si la valeur est true, la file d’attente prend en charge la session et seule SessionReceiver est prise en charge. Les files d’attente prenant en charge les sessions ne sont pas prises en charge via REST. Settable uniquement au moment de la création de la file d’attente.

requiresSession: boolean

Valeur de propriété

boolean

status

État de l’entité de messagerie.

status: EntityStatus

Valeur de propriété

EntityStatus

userMetadata

L’utilisateur a fourni des informations de métadonnées associées à la file d’attente. Permet de spécifier du contenu textuel tel que des étiquettes, des étiquettes, etc. La valeur ne doit pas dépasser 1024 octets encodés en utf-8.

userMetadata: string

Valeur de propriété

string