Partager via

CreateQueueOptions interface

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

Représente des options paramétrables dans une file d’attente

Extends
OperationOptions

Propriétés

authorizationRules

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

Temps d’inactivité maximal avant la suppression de l’entité. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 vers la sous-file d’attente de lettres mortes de la file d’attente. S’il est désactivé, le message est définitivement supprimé de la file d’attente. Valeur pouvant être définie 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 pendant plus longtemps que la durée spécifiée. Cette valeur est remplacée par une durée de vie spécifiée sur le message si et seulement si la durée de vie du message est inférieure à la durée de vie définie sur la file d'attente. Cette valeur est immuable une fois la file d’attente créée. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 des messages. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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

URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages en lettres mortes doivent être transférés. Par exemple, une entrée d’URL absolue se présente sous 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 se présente sous la forme sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

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

Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 remises de messages après lequel, 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 envoyés à cette file d’attente, en kilo-octets.

(Configurable uniquement pour l’espace de noms Service Bus de niveau Premium.)
maxSizeInMegabytes

Spécifie la taille maximale de la file d'attente en mégaoctets. Toute tentative de placement d'un message dans la file d'attente qui entraînera le dépassement de cette valeur dans la file d'attente échouera.
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. Valeur pouvant être définie 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 la session ne sont pas prises en charge dans REST. Valeur pouvant être définie 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. Utilisé pour spécifier du contenu textuel tel que des étiquettes, des étiquettes, etc. La valeur ne doit pas dépasser 1 024 octets encodés en utf-8.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour annuler les demandes.
onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
serializerOptions

Options permettant de remplacer le comportement de sérialisation/dés sérialisation.
tracingOptions

Options utilisées lorsque le suivi est activé.

Détails de la propriété

authorizationRules

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

authorizationRules?: AuthorizationRule[]

Valeur de propriété

AuthorizationRule[]

autoDeleteOnIdle

Temps d’inactivité maximal avant la suppression de l’entité. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 vers la sous-file d’attente de lettres mortes de la file d’attente. S’il est désactivé, le message est définitivement supprimé de la file d’attente. Valeur pouvant être définie 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 pendant plus longtemps que la durée spécifiée. Cette valeur est remplacée par une durée de vie spécifiée sur le message si et seulement si la durée de vie du message est inférieure à la durée de vie définie sur la file d'attente. Cette valeur est immuable une fois la file d’attente créée. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 des messages. Cela doit être spécifié au format de durée ISO-8601, par exemple « 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

URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages en lettres mortes doivent être transférés. Par exemple, une entrée d’URL absolue se présente sous 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 se présente sous 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 durant laquelle un message doit être verrouillé pour traitement par un récepteur. Après cette période, le message est déverrouillé et disponible à la consommation pour le récepteur suivant. (Si les sessions sont activées, cette durée de verrouillage s’applique aux sessions et non aux messages.)

Cela doit être spécifié au format de durée ISO-8601, par exemple « 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 remises de messages après lequel, 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 envoyés à cette file d’attente, en kilo-octets.

(Configurable uniquement pour l’espace de noms Service Bus de niveau Premium.)

maxMessageSizeInKilobytes?: number

Valeur de propriété

number

maxSizeInMegabytes

Spécifie la taille maximale de la file d'attente en mégaoctets. Toute tentative de placement d'un message dans la file d'attente qui entraînera le dépassement de cette valeur dans la file d'attente échouera.

maxSizeInMegabytes?: number

Valeur de propriété

number

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. Valeur pouvant être définie 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 la session ne sont pas prises en charge dans REST. Valeur pouvant être définie 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. Utilisé pour spécifier du contenu textuel tel que des étiquettes, des étiquettes, etc. La valeur ne doit pas dépasser 1 024 octets encodés en utf-8.

userMetadata?: string

Valeur de propriété

string

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

abortSignal

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

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité deOperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité deOperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité deOperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/dés sérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

Hérité deOperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité deOperationOptions.tracingOptions