CreateSubscriptionOptions interface

Paket:

@azure/service-bus

Representerar alternativ som kan konfigureras för en prenumeration

Extends

OperationOptions

Egenskaper

autoDeleteOnIdle	Maximal inaktivitetstid innan entiteten tas bort. Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder. Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	Tillgänglighetsstatus för meddelandeentiteten.
deadLetteringOnFilterEvaluationExceptions	Avgör hur Service Bus hanterar ett meddelande som orsakar ett undantag under en prenumerations filterutvärdering. Om värdet är inställt på true flyttas meddelandet som orsakade undantaget till prenumerationens underkö med obeställbara bokstäver. Annars tas den bort. Som standard är den här parametern inställd på true, vilket ger användaren en chans att undersöka orsaken till undantaget. Det kan inträffa från ett felaktigt meddelande eller några felaktiga antaganden som görs i filtret om meddelandets form. Kan endast användas vid tidpunkten för att skapa ämnet.
deadLetteringOnMessageExpiration	Om det är aktiverat och ett meddelande upphör att gälla flyttar Service Bus meddelandet från kön till prenumerationens underkö med obeställbara bokstäver. Om det är inaktiverat tas meddelandet bort permanent från prenumerationens huvudkö. Kan endast användas när prenumerationen skapas.
defaultMessageTimeToLive	Avgör hur länge ett meddelande finns i prenumerationen. Baserat på om obeställbara bokstäver är aktiverat flyttas ett meddelande vars TTL har upphört att gälla antingen till prenumerationens associerade DeadLtterQueue eller tas bort permanent. Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder. Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions	Representerar alternativen för att skapa standardregeln för prenumerationen.
enableBatchedOperations	Anger om batchåtgärder ska tillåtas.
forwardDeadLetteredMessagesTo	Absolut URL eller namnet på kön eller ämnet som de obeställbara meddelandena ska vidarebefordras till. Till exempel skulle en absolut URL-inmatning vara av formuläret sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	Absolut URL eller namnet på kön eller ämnet som meddelandena ska vidarebefordras till. Till exempel skulle en absolut URL-inmatning vara av formuläret sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	Standardlåsets varaktighet tillämpas på prenumerationer som inte definierar en låsvaraktighet. (Om sessioner är aktiverade gäller den här låsvaraktigheten för sessioner och inte för meddelanden.) Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder. Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	Det maximala leveransantalet meddelanden varefter om det fortfarande inte är avgjort flyttas till delkön med obeställbara meddelanden.
requiresSession	Om värdet är true är prenumerationen sessionsmedveten och endast SessionReceiver stöds. Sessionsmedveten prenumeration stöds inte via REST. Kan endast användas när prenumerationen skapas.
status	Status för meddelandeentiteten.
userMetadata	Användaren tillhandahöll metadatainformation som är associerad med prenumerationen. Används för att ange textinnehåll, till exempel taggar, etiketter osv. Värdet får inte överstiga 1 024 byte som kodas i utf-8.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
serializerOptions	Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

autoDeleteOnIdle

Maximal inaktivitetstid innan entiteten tas bort. Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder.

Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Egenskapsvärde

string

availabilityStatus

Tillgänglighetsstatus för meddelandeentiteten.

availabilityStatus?: EntityAvailabilityStatus

Egenskapsvärde

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Avgör hur Service Bus hanterar ett meddelande som orsakar ett undantag under en prenumerations filterutvärdering. Om värdet är inställt på true flyttas meddelandet som orsakade undantaget till prenumerationens underkö med obeställbara bokstäver. Annars tas den bort. Som standard är den här parametern inställd på true, vilket ger användaren en chans att undersöka orsaken till undantaget. Det kan inträffa från ett felaktigt meddelande eller några felaktiga antaganden som görs i filtret om meddelandets form. Kan endast användas vid tidpunkten för att skapa ämnet.

deadLetteringOnFilterEvaluationExceptions?: boolean

Egenskapsvärde

boolean

deadLetteringOnMessageExpiration

Om det är aktiverat och ett meddelande upphör att gälla flyttar Service Bus meddelandet från kön till prenumerationens underkö med obeställbara bokstäver. Om det är inaktiverat tas meddelandet bort permanent från prenumerationens huvudkö. Kan endast användas när prenumerationen skapas.

deadLetteringOnMessageExpiration?: boolean

Egenskapsvärde

boolean

defaultMessageTimeToLive

Avgör hur länge ett meddelande finns i prenumerationen. Baserat på om obeställbara bokstäver är aktiverat flyttas ett meddelande vars TTL har upphört att gälla antingen till prenumerationens associerade DeadLtterQueue eller tas bort permanent. Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder.

Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Egenskapsvärde

string

defaultRuleOptions

Representerar alternativen för att skapa standardregeln för prenumerationen.

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

Egenskapsvärde

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

enableBatchedOperations

Anger om batchåtgärder ska tillåtas.

enableBatchedOperations?: boolean

Egenskapsvärde

boolean

forwardDeadLetteredMessagesTo

Absolut URL eller namnet på kön eller ämnet som de obeställbara meddelandena ska vidarebefordras till. Till exempel skulle en absolut URL-inmatning vara av formuläret sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Egenskapsvärde

string

forwardTo

Absolut URL eller namnet på kön eller ämnet som meddelandena ska vidarebefordras till. Till exempel skulle en absolut URL-inmatning vara av formuläret sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Egenskapsvärde

string

lockDuration

Standardlåsets varaktighet tillämpas på prenumerationer som inte definierar en låsvaraktighet. (Om sessioner är aktiverade gäller den här låsvaraktigheten för sessioner och inte för meddelanden.)

Detta ska anges i ISO-8601-varaktighetsformat, till exempel "PT1M" i 1 minut, "PT5S" i 5 sekunder.

Mer information om ISO-8601-varaktighetsformat: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Egenskapsvärde

string

maxDeliveryCount

Det maximala leveransantalet meddelanden varefter om det fortfarande inte är avgjort flyttas till delkön med obeställbara meddelanden.

maxDeliveryCount?: number

Egenskapsvärde

number

requiresSession

Om värdet är true är prenumerationen sessionsmedveten och endast SessionReceiver stöds. Sessionsmedveten prenumeration stöds inte via REST. Kan endast användas när prenumerationen skapas.

requiresSession?: boolean

Egenskapsvärde

boolean

status

Status för meddelandeentiteten.

status?: EntityStatus

Egenskapsvärde

EntityStatus

userMetadata

Användaren tillhandahöll metadatainformation som är associerad med prenumerationen. Används för att ange textinnehåll, till exempel taggar, etiketter osv. Värdet får inte överstiga 1 024 byte som kodas i utf-8.

userMetadata?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

ärvd frånOperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

ärvs frånOperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

ärvs frånOperationOptions.requestOptions

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

ärvs frånOperationOptions.serializerOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd frånOperationOptions.tracingOptions