Freigeben über


CreateSubscriptionOptions interface

Stellt festgelegte Optionen für ein Abonnement dar.

Extends

Eigenschaften

autoDeleteOnIdle

Maximale Leerlaufzeit vor dem Löschen der Entität. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

availabilityStatus

Verfügbarkeitsstatus der Nachrichtenentität.

deadLetteringOnFilterEvaluationExceptions

Bestimmt, wie der Servicebus eine Nachricht verarbeitet, die während der Filterauswertung eines Abonnements eine Ausnahme verursacht. Wenn der Wert auf "true" festgelegt ist, wird die Nachricht, die die Ausnahme verursacht hat, in die Unterwarteschlange des Abonnements verschoben. Andernfalls wird sie verworfen. Dieser Parameter ist standardmäßig auf "true" festgelegt, sodass der Benutzer die Ursache der Ausnahme untersuchen kann. Es kann aus einer falsch formatierten Nachricht oder einigen falschen Annahmen im Filter über die Form der Nachricht auftreten. Nur zum Zeitpunkt der Themenerstellung einstellbar.

deadLetteringOnMessageExpiration

Wenn sie aktiviert ist und eine Nachricht abläuft, verschiebt der Servicebus die Nachricht aus der Warteschlange in die Unterwarteschlange des Abonnements in die Warteschlange mit einem inaktiven Buchstaben. Wenn sie deaktiviert ist, wird die Nachricht endgültig aus der Hauptwarteschlange des Abonnements gelöscht. Nur zum Zeitpunkt der Abonnementerstellung einstellbar.

defaultMessageTimeToLive

Bestimmt, wie lange eine Nachricht im Abonnement lebt. Basierend darauf, ob die Inschrift aktiviert ist, wird eine Nachricht, deren TTL abgelaufen ist, entweder in die zugeordnete DeadLtterQueue des Abonnements verschoben oder endgültig gelöscht. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultRuleOptions

Stellt die Optionen zum Erstellen der Standardregel für das Abonnement dar.

enableBatchedOperations

Gibt an, ob Batchvorgänge zulässig sein sollen.

forwardDeadLetteredMessagesTo

Absolute URL oder der Name der Warteschlange oder des Themas, an die die Nachrichten mit Inschrift weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe aus dem Formular sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo

Absolute URL oder der Name der Warteschlange oder des Themas, an die die Nachrichten weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe aus dem Formular sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

lockDuration

Die Standardsperrdauer wird auf Abonnements angewendet, die keine Sperrdauer definieren. (Wenn Sitzungen aktiviert sind, gilt diese Sperrdauer für Sitzungen und nicht für Nachrichten.)

Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

maxDeliveryCount

Die maximale Zustellungsanzahl von Nachrichten, nach denen, wenn sie noch nicht festgelegt ist, in die Unterwarteschlange für den Toten Buchstaben verschoben wird.

requiresSession

Wenn dieser Wert auf "true" festgelegt ist, wird das Abonnement sitzungsfähig, und nur SessionReceiver wird unterstützt. Das sitzungsfähige Abonnement wird über REST nicht unterstützt. Nur zum Zeitpunkt der Abonnementerstellung einstellbar.

status

Status der Nachrichtenentität.

userMetadata

Der Benutzer hat Metadateninformationen bereitgestellt, die dem Abonnement zugeordnet sind. Wird verwendet, um Textinhalte wie Tags, Bezeichnungen usw. anzugeben. Der Wert darf 1024 Bytes, die in utf-8 codiert sind, nicht überschreiten.

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

autoDeleteOnIdle

Maximale Leerlaufzeit vor dem Löschen der Entität. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Eigenschaftswert

string

availabilityStatus

Verfügbarkeitsstatus der Nachrichtenentität.

availabilityStatus?: EntityAvailabilityStatus

Eigenschaftswert

deadLetteringOnFilterEvaluationExceptions

Bestimmt, wie der Servicebus eine Nachricht verarbeitet, die während der Filterauswertung eines Abonnements eine Ausnahme verursacht. Wenn der Wert auf "true" festgelegt ist, wird die Nachricht, die die Ausnahme verursacht hat, in die Unterwarteschlange des Abonnements verschoben. Andernfalls wird sie verworfen. Dieser Parameter ist standardmäßig auf "true" festgelegt, sodass der Benutzer die Ursache der Ausnahme untersuchen kann. Es kann aus einer falsch formatierten Nachricht oder einigen falschen Annahmen im Filter über die Form der Nachricht auftreten. Nur zum Zeitpunkt der Themenerstellung einstellbar.

deadLetteringOnFilterEvaluationExceptions?: boolean

Eigenschaftswert

boolean

deadLetteringOnMessageExpiration

Wenn sie aktiviert ist und eine Nachricht abläuft, verschiebt der Servicebus die Nachricht aus der Warteschlange in die Unterwarteschlange des Abonnements in die Warteschlange mit einem inaktiven Buchstaben. Wenn sie deaktiviert ist, wird die Nachricht endgültig aus der Hauptwarteschlange des Abonnements gelöscht. Nur zum Zeitpunkt der Abonnementerstellung einstellbar.

deadLetteringOnMessageExpiration?: boolean

Eigenschaftswert

boolean

defaultMessageTimeToLive

Bestimmt, wie lange eine Nachricht im Abonnement lebt. Basierend darauf, ob die Inschrift aktiviert ist, wird eine Nachricht, deren TTL abgelaufen ist, entweder in die zugeordnete DeadLtterQueue des Abonnements verschoben oder endgültig gelöscht. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Eigenschaftswert

string

defaultRuleOptions

Stellt die Optionen zum Erstellen der Standardregel für das Abonnement dar.

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

Eigenschaftswert

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

enableBatchedOperations

Gibt an, ob Batchvorgänge zulässig sein sollen.

enableBatchedOperations?: boolean

Eigenschaftswert

boolean

forwardDeadLetteredMessagesTo

Absolute URL oder der Name der Warteschlange oder des Themas, an die die Nachrichten mit Inschrift weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe aus dem Formular sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Eigenschaftswert

string

forwardTo

Absolute URL oder der Name der Warteschlange oder des Themas, an die die Nachrichten weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe aus dem Formular sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Eigenschaftswert

string

lockDuration

Die Standardsperrdauer wird auf Abonnements angewendet, die keine Sperrdauer definieren. (Wenn Sitzungen aktiviert sind, gilt diese Sperrdauer für Sitzungen und nicht für Nachrichten.)

Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für 1 Minute, "PT5S" für 5 Sekunden.

Mehr zum ISO-8601-Dauerformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Eigenschaftswert

string

maxDeliveryCount

Die maximale Zustellungsanzahl von Nachrichten, nach denen, wenn sie noch nicht festgelegt ist, in die Unterwarteschlange für den Toten Buchstaben verschoben wird.

maxDeliveryCount?: number

Eigenschaftswert

number

requiresSession

Wenn dieser Wert auf "true" festgelegt ist, wird das Abonnement sitzungsfähig, und nur SessionReceiver wird unterstützt. Das sitzungsfähige Abonnement wird über REST nicht unterstützt. Nur zum Zeitpunkt der Abonnementerstellung einstellbar.

requiresSession?: boolean

Eigenschaftswert

boolean

status

Status der Nachrichtenentität.

status?: EntityStatus

Eigenschaftswert

userMetadata

Der Benutzer hat Metadateninformationen bereitgestellt, die dem Abonnement zugeordnet sind. Wird verwendet, um Textinhalte wie Tags, Bezeichnungen usw. anzugeben. Der Wert darf 1024 Bytes, die in utf-8 codiert sind, nicht überschreiten.

userMetadata?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

vonOperationOptions.abortSignal

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

vonOperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

vonOperationOptions.requestOptions

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

vonOperationOptions.serializerOptions- geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

von"OperationOptions.tracingOptions" geerbt