CreateSubscriptionOptions interface

Paquet:

@azure/service-bus

Représente des options définissables sur un abonnement

Extends

OperationOptions

Propriétés

autoDeleteOnIdle	Temps d’inactivité maximal avant la suppression de l’entité. Cela doit être spécifié au format de durée ISO-8601, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes. En savoir plus 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.
deadLetteringOnFilterEvaluationExceptions	Détermine la façon dont Service Bus gère un message qui provoque une exception lors de l’évaluation du filtre d’un abonnement. Si la valeur est définie sur true, le message à l’origine de l’exception est déplacé vers la sous-file d’attente de lettres mortes de l’abonnement. Sinon, elle sera ignorée. Par défaut, ce paramètre est défini sur true, ce qui permet à l’utilisateur d’examiner la cause de l’exception. Elle peut résulter d'un message mal formé ou d'hypothèses erronées faites dans le filtre concernant la forme du message. Valeur pouvant être définie uniquement au moment de la création de la rubrique.
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 l’abonnement. S’il est désactivé, le message est définitivement supprimé de la file d’attente principale de l’abonnement. Valeur pouvant être définie uniquement au moment de la création de l'abonnement.
defaultMessageTimeToLive	Détermine la durée de vie d'un message dans l'abonnement. Selon que la mise en lettres mortes est activée, un message dont la durée de vie a expiré est déplacé vers l’abonnement DeadLtterQueue associé ou définitivement supprimé. Cela doit être spécifié au format de durée ISO-8601, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes. En savoir plus sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions	Représente les options permettant de créer la règle par défaut pour l’abonnement.
enableBatchedOperations	Spécifie si les opérations par lot doivent être autorisées.
forwardDeadLetteredMessagesTo	URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages à 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	La durée de verrouillage pas défaut s'applique aux abonnements qui ne définissent pas de durée de verrouillage. (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, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes. En savoir plus 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.
requiresSession	Si la valeur est true, l’abonnement prend en charge la session et seul SessionReceiver est pris en charge. Les abonnements prenant en charge les sessions ne sont pas pris en charge via REST. Valeur pouvant être définie uniquement au moment de la création de l'abonnement.
status	État de l’entité de messagerie.
userMetadata	L’utilisateur a fourni des informations de métadonnées associées à l’abonnement. Permet de 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 abandonner 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érialisation.
tracingOptions	Options utilisées lorsque le traçage est activé.

Détails de la propriété

autoDeleteOnIdle

Temps d’inactivité maximal avant la suppression de l’entité. Cela doit être spécifié au format de durée ISO-8601, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

En savoir plus 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

deadLetteringOnFilterEvaluationExceptions

Détermine la façon dont Service Bus gère un message qui provoque une exception lors de l’évaluation du filtre d’un abonnement. Si la valeur est définie sur true, le message à l’origine de l’exception est déplacé vers la sous-file d’attente de lettres mortes de l’abonnement. Sinon, elle sera ignorée. Par défaut, ce paramètre est défini sur true, ce qui permet à l’utilisateur d’examiner la cause de l’exception. Elle peut résulter d'un message mal formé ou d'hypothèses erronées faites dans le filtre concernant la forme du message. Valeur pouvant être définie uniquement au moment de la création de la rubrique.

deadLetteringOnFilterEvaluationExceptions?: boolean

Valeur de propriété

boolean

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 l’abonnement. S’il est désactivé, le message est définitivement supprimé de la file d’attente principale de l’abonnement. Valeur pouvant être définie uniquement au moment de la création de l'abonnement.

deadLetteringOnMessageExpiration?: boolean

Valeur de propriété

boolean

defaultMessageTimeToLive

Détermine la durée de vie d'un message dans l'abonnement. Selon que la mise en lettres mortes est activée, un message dont la durée de vie a expiré est déplacé vers l’abonnement DeadLtterQueue associé ou définitivement supprimé. Cela doit être spécifié au format de durée ISO-8601, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

En savoir plus sur le format de durée ISO-8601 : https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Valeur de propriété

string

defaultRuleOptions

Représente les options permettant de créer la règle par défaut pour l’abonnement.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

Valeur de propriété

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

enableBatchedOperations

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

enableBatchedOperations?: boolean

Valeur de propriété

boolean

forwardDeadLetteredMessagesTo

URL absolue ou nom de la file d’attente ou de la rubrique vers laquelle les messages à 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

La durée de verrouillage pas défaut s'applique aux abonnements qui ne définissent pas de durée de verrouillage. (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, tel que « PT1M » pendant 1 minute, « PT5S » pendant 5 secondes.

En savoir plus 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

requiresSession

Si la valeur est true, l’abonnement prend en charge la session et seul SessionReceiver est pris en charge. Les abonnements prenant en charge les sessions ne sont pas pris en charge via REST. Valeur pouvant être définie uniquement au moment de la création de l'abonnement.

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 à l’abonnement. Permet de 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 abandonner 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érialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

Héritéed’OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le traçage est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Héritéd’OperationOptions.tracingOptions