Freigeben über

CreateSubscriptionOptions interface

  • Referenz
Paket:
@azure/service-bus

Stellt festlegbare Optionen für ein Abonnement dar.

Extends
OperationOptions

Eigenschaften

autoDeleteOnIdle

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

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

Verfügbarkeitsstatus der Messagingentität.
deadLetteringOnFilterEvaluationExceptions

Bestimmt, wie Service Bus 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 Unzustellbare Unterwarteschlange des Abonnements verschoben. Andernfalls wird sie verworfen. Standardmäßig ist dieser Parameter auf TRUE festgelegt, sodass der Benutzer die Möglichkeit hat, die Ursache der Ausnahme zu untersuchen. Die Ausnahme kann aufgrund einer falsch formatierten Nachricht oder falscher Annahmen im Filter bezüglich der Form der Nachricht auftreten. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Themas festgelegt werden.
deadLetteringOnMessageExpiration

Wenn sie aktiviert ist und eine Nachricht abläuft, verschiebt Service Bus die Nachricht aus der Warteschlange in die Unzustellbare Unterwarteschlange des Abonnements. Wenn sie deaktiviert ist, wird die Nachricht endgültig aus der Hauptwarteschlange des Abonnements gelöscht. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Abonnements festgelegt werden.
defaultMessageTimeToLive

Legt fest, wie lange eine Nachricht im Abonnement aktiv ist. Je nachdem, ob unzustellbare Buchstaben aktiviert sind, wird eine Nachricht, deren Gültigkeitsdauer abgelaufen ist, entweder in das zugeordnete DeadLtterQueue des Abonnements verschoben oder endgültig gelöscht. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für eine Minute, "PT5S" für 5 Sekunden.

Weitere Informationen 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 nachrichten mit unzustellbaren Buchstaben weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe von der Form sein. 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 von der Form sein. sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

Die Sperrenstandarddauer wird auf Abonnements angewendet, die keine Sperrendauer 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 eine Minute, "PT5S" für 5 Sekunden.

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

Die maximale Übermittlungsanzahl von Nachrichten, nach der, wenn sie immer noch nicht abgerechnet wird, in die Unterwarteschlange für unzustellbare Nachrichten verschoben wird.
requiresSession

Wenn auf true festgelegt ist, wird das Abonnement sitzungsfähig, und nur SessionReceiver wird unterstützt. Sitzungsfähige Abonnements werden nicht über REST unterstützt. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Abonnements festgelegt werden.
status

Status der Messagingentitä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 beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.
requestOptions

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

Optionen zum Überschreiben 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 eine Minute, "PT5S" für 5 Sekunden.

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

autoDeleteOnIdle?: string

Eigenschaftswert

string

availabilityStatus

Verfügbarkeitsstatus der Messagingentität.

availabilityStatus?: EntityAvailabilityStatus

Eigenschaftswert

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Bestimmt, wie Service Bus 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 Unzustellbare Unterwarteschlange des Abonnements verschoben. Andernfalls wird sie verworfen. Standardmäßig ist dieser Parameter auf TRUE festgelegt, sodass der Benutzer die Möglichkeit hat, die Ursache der Ausnahme zu untersuchen. Die Ausnahme kann aufgrund einer falsch formatierten Nachricht oder falscher Annahmen im Filter bezüglich der Form der Nachricht auftreten. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Themas festgelegt werden.

deadLetteringOnFilterEvaluationExceptions?: boolean

Eigenschaftswert

boolean

deadLetteringOnMessageExpiration

Wenn sie aktiviert ist und eine Nachricht abläuft, verschiebt Service Bus die Nachricht aus der Warteschlange in die Unzustellbare Unterwarteschlange des Abonnements. Wenn sie deaktiviert ist, wird die Nachricht endgültig aus der Hauptwarteschlange des Abonnements gelöscht. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Abonnements festgelegt werden.

deadLetteringOnMessageExpiration?: boolean

Eigenschaftswert

boolean

defaultMessageTimeToLive

Legt fest, wie lange eine Nachricht im Abonnement aktiv ist. Je nachdem, ob unzustellbare Buchstaben aktiviert sind, wird eine Nachricht, deren Gültigkeitsdauer abgelaufen ist, entweder in das zugeordnete DeadLtterQueue des Abonnements verschoben oder endgültig gelöscht. Dies ist im ISO-8601-Dauerformat anzugeben, z. B. "PT1M" für eine Minute, "PT5S" für 5 Sekunden.

Weitere Informationen 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 nachrichten mit unzustellbaren Buchstaben weitergeleitet werden sollen. Beispielsweise würde eine absolute URL-Eingabe von der Form sein. 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 von der Form sein. sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Eigenschaftswert

string

lockDuration

Die Sperrenstandarddauer wird auf Abonnements angewendet, die keine Sperrendauer 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 eine Minute, "PT5S" für 5 Sekunden.

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

lockDuration?: string

Eigenschaftswert

string

maxDeliveryCount

Die maximale Übermittlungsanzahl von Nachrichten, nach der, wenn sie immer noch nicht abgerechnet wird, in die Unterwarteschlange für unzustellbare Nachrichten verschoben wird.

maxDeliveryCount?: number

Eigenschaftswert

number

requiresSession

Wenn auf true festgelegt ist, wird das Abonnement sitzungsfähig, und nur SessionReceiver wird unterstützt. Sitzungsfähige Abonnements werden nicht über REST unterstützt. Diese Eigenschaft kann nur zum Erstellungszeitpunkt des Abonnements festgelegt werden.

requiresSession?: boolean

Eigenschaftswert

boolean

status

Status der Messagingentität.

status?: EntityStatus

Eigenschaftswert

EntityStatus

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

AbortSignalLike

Geerbt vonOperationOptions.abortSignal

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

Geerbt vonOperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Geerbt vonOperationOptions.requestOptions

serializerOptions

Optionen zum Überschreiben des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

Geerbt vonOperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt vonOperationOptions.tracingOptions