Delen via

CreateSubscriptionOptions interface

  • Referentie
Pakket:
@azure/service-bus

Vertegenwoordigt instelbare opties voor een abonnement

Extends
OperationOptions

Eigenschappen

autoDeleteOnIdle

Maximale inactieve tijd voordat de entiteit wordt verwijderd. Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Beschikbaarheidsstatus van de berichtenentiteit.
deadLetteringOnFilterEvaluationExceptions

Bepaalt hoe Service Bus een bericht verwerkt dat een uitzondering veroorzaakt tijdens de filterevaluatie van een abonnement. Als de waarde is ingesteld op true, wordt het bericht dat de uitzondering heeft veroorzaakt, verplaatst naar de subwachtrij met onbestelbare berichten van het abonnement. Anders wordt het verwijderd. Deze parameter is standaard ingesteld op true, zodat de gebruiker de kans heeft om de oorzaak van de uitzondering te onderzoeken. Dit kan optreden als gevolg van een onjuist ingedeeld bericht of enkele onjuiste veronderstellingen in het filter over de vorm van het bericht. Alleen instelbaar op het moment dat het onderwerp wordt gemaakt.
deadLetteringOnMessageExpiration

Als dit is ingeschakeld en een bericht verloopt, verplaatst de Service Bus het bericht van de wachtrij naar de subwachtrij met onbestelbare berichten van het abonnement. Als dit is uitgeschakeld, wordt het bericht definitief verwijderd uit de hoofdwachtrij van het abonnement. Alleen instelbaar tijdens het maken van het abonnement.
defaultMessageTimeToLive

Bepaalt hoe lang een bericht zich in het abonnement bevindt. Op basis van of dead-lettering is ingeschakeld, wordt een bericht waarvan de TTL is verlopen verplaatst naar de bijbehorende DeadLtterQueue van het abonnement of definitief verwijderd. Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions

Vertegenwoordigt de opties voor het maken van de standaardregel voor het abonnement.
enableBatchedOperations

Hiermee geeft u op of batchbewerkingen moeten worden toegestaan.
forwardDeadLetteredMessagesTo

Absolute URL of de naam van de wachtrij of het onderwerp waarnaar de berichten met een onbestelbare brief moeten worden doorgestuurd. Een absolute URL-invoer zou bijvoorbeeld de vorm hebben sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

Absolute URL of de naam van de wachtrij of het onderwerp waarnaar de berichten moeten worden doorgestuurd. Een absolute URL-invoer zou bijvoorbeeld de vorm hebben sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

De standaardvergrendelingsduur wordt toegepast op abonnementen die geen vergrendelingsduur definiëren. (Als sessies zijn ingeschakeld, is deze vergrendelingsduur van toepassing op sessies en niet op berichten.)

Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

Het maximale aantal bezorgingsberichten, waarna, als het nog steeds niet is geregeld, wordt verplaatst naar de subwachtrij voor onbestelbare berichten.
requiresSession

Als dit is ingesteld op true, is het abonnement sessiebewust en wordt alleen SessionReceiver ondersteund. Sessiebewuste abonnementen worden niet ondersteund via REST. Alleen instelbaar tijdens het maken van het abonnement.
status

Status van de berichtenentiteit.
userMetadata

De gebruiker heeft metagegevensgegevens opgegeven die zijn gekoppeld aan het abonnement. Wordt gebruikt om tekstuele inhoud op te geven, zoals tags, labels, enzovoort. De waarde mag niet groter zijn dan 1024 bytes gecodeerd in utf-8.

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse

Een functie die telkens wordt aangeroepen wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.
tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

autoDeleteOnIdle

Maximale inactieve tijd voordat de entiteit wordt verwijderd. Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Waarde van eigenschap

string

availabilityStatus

Beschikbaarheidsstatus van de berichtenentiteit.

availabilityStatus?: EntityAvailabilityStatus

Waarde van eigenschap

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Bepaalt hoe Service Bus een bericht verwerkt dat een uitzondering veroorzaakt tijdens de filterevaluatie van een abonnement. Als de waarde is ingesteld op true, wordt het bericht dat de uitzondering heeft veroorzaakt, verplaatst naar de subwachtrij met onbestelbare berichten van het abonnement. Anders wordt het verwijderd. Deze parameter is standaard ingesteld op true, zodat de gebruiker de kans heeft om de oorzaak van de uitzondering te onderzoeken. Dit kan optreden als gevolg van een onjuist ingedeeld bericht of enkele onjuiste veronderstellingen in het filter over de vorm van het bericht. Alleen instelbaar op het moment dat het onderwerp wordt gemaakt.

deadLetteringOnFilterEvaluationExceptions?: boolean

Waarde van eigenschap

boolean

deadLetteringOnMessageExpiration

Als dit is ingeschakeld en een bericht verloopt, verplaatst de Service Bus het bericht van de wachtrij naar de subwachtrij met onbestelbare berichten van het abonnement. Als dit is uitgeschakeld, wordt het bericht definitief verwijderd uit de hoofdwachtrij van het abonnement. Alleen instelbaar tijdens het maken van het abonnement.

deadLetteringOnMessageExpiration?: boolean

Waarde van eigenschap

boolean

defaultMessageTimeToLive

Bepaalt hoe lang een bericht zich in het abonnement bevindt. Op basis van of dead-lettering is ingeschakeld, wordt een bericht waarvan de TTL is verlopen verplaatst naar de bijbehorende DeadLtterQueue van het abonnement of definitief verwijderd. Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Waarde van eigenschap

string

defaultRuleOptions

Vertegenwoordigt de opties voor het maken van de standaardregel voor het abonnement.

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

Waarde van eigenschap

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

enableBatchedOperations

Hiermee geeft u op of batchbewerkingen moeten worden toegestaan.

enableBatchedOperations?: boolean

Waarde van eigenschap

boolean

forwardDeadLetteredMessagesTo

Absolute URL of de naam van de wachtrij of het onderwerp waarnaar de berichten met een onbestelbare brief moeten worden doorgestuurd. Een absolute URL-invoer zou bijvoorbeeld de vorm hebben sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Waarde van eigenschap

string

forwardTo

Absolute URL of de naam van de wachtrij of het onderwerp waarnaar de berichten moeten worden doorgestuurd. Een absolute URL-invoer zou bijvoorbeeld de vorm hebben sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Waarde van eigenschap

string

lockDuration

De standaardvergrendelingsduur wordt toegepast op abonnementen die geen vergrendelingsduur definiëren. (Als sessies zijn ingeschakeld, is deze vergrendelingsduur van toepassing op sessies en niet op berichten.)

Dit moet worden opgegeven in ISO-8601-duurnotatie, zoals "PT1M" voor 1 minuut, "PT5S" gedurende 5 seconden.

Meer informatie over de ISO-8601-duurindeling: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Waarde van eigenschap

string

maxDeliveryCount

Het maximale aantal bezorgingsberichten, waarna, als het nog steeds niet is geregeld, wordt verplaatst naar de subwachtrij voor onbestelbare berichten.

maxDeliveryCount?: number

Waarde van eigenschap

number

requiresSession

Als dit is ingesteld op true, is het abonnement sessiebewust en wordt alleen SessionReceiver ondersteund. Sessiebewuste abonnementen worden niet ondersteund via REST. Alleen instelbaar tijdens het maken van het abonnement.

requiresSession?: boolean

Waarde van eigenschap

boolean

status

Status van de berichtenentiteit.

status?: EntityStatus

Waarde van eigenschap

EntityStatus

userMetadata

De gebruiker heeft metagegevensgegevens opgegeven die zijn gekoppeld aan het abonnement. Wordt gebruikt om tekstuele inhoud op te geven, zoals tags, labels, enzovoort. De waarde mag niet groter zijn dan 1024 bytes gecodeerd in utf-8.

userMetadata?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

Overgenomen vanOperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

Overgenomen vanOperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

Overgenomen vanOperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

Overgenomen vanOperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

Overgenomen vanOperationOptions.tracingOptions