Udostępnij za pośrednictwem

CreateSubscriptionOptions interface

  • Odwołanie
Pakiet:
@azure/service-bus

Reprezentuje opcje ustawiania w subskrypcji

Rozszerzenie
OperationOptions

Właściwości

autoDeleteOnIdle

Maksymalny czas bezczynności przed usunięciem jednostki. Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Stan dostępności jednostki obsługi komunikatów.
deadLetteringOnFilterEvaluationExceptions

Określa sposób obsługi komunikatu przez usługę Service Bus, który powoduje wyjątek podczas oceny filtru subskrypcji. Jeśli wartość jest ustawiona na true, komunikat, który spowodował wyjątek, zostanie przeniesiony do kolejki podrzędnej utraconych komunikatów subskrypcji. W przeciwnym razie zostanie odrzucona. Domyślnie ten parametr ma wartość true, umożliwiając użytkownikowi możliwość zbadania przyczyny wyjątku. Może to nastąpić z źle sformułowanego komunikatu lub niektórych nieprawidłowych założeń w filtrze dotyczącym formy wiadomości. Ustaw tabelę tylko w czasie tworzenia tematu.
deadLetteringOnMessageExpiration

Jeśli jest włączona, a komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki w kolejce podrzędnej subskrypcji. Jeśli ta funkcja zostanie wyłączona, komunikat zostanie trwale usunięty z głównej kolejki subskrypcji. Ustaw tabelę tylko w czasie tworzenia subskrypcji.
defaultMessageTimeToLive

Określa, jak długo w subskrypcji znajduje się komunikat. W zależności od tego, czy włączono wysyłanie utraconych komunikatów, których czas wygaśnięcia wygasł, zostanie przeniesiony do skojarzonej subskrypcji deadLtterQueue lub trwale usuniętej. Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions

Reprezentuje opcje tworzenia reguły domyślnej dla subskrypcji.
enableBatchedOperations

Określa, czy operacje wsadowe powinny być dozwolone.
forwardDeadLetteredMessagesTo

Bezwzględny adres URL lub nazwa kolejki lub tematu, do których mają być przekazywane komunikaty z komunikatami utraconymi. Na przykład bezwzględne dane wejściowe adresu URL będą miały postać sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

Bezwzględny adres URL lub nazwa kolejki lub tematu, do których mają być przekazywane komunikaty. Na przykład bezwzględne dane wejściowe adresu URL będą miały postać sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

Domyślny czas trwania blokady jest stosowany do subskrypcji, które nie definiują czasu trwania blokady. (Jeśli sesje są włączone, ten czas trwania blokady ma zastosowanie do sesji, a nie dla komunikatów).

Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

Maksymalna liczba komunikatów, po których, jeśli nadal nie zostanie rozstrzygnięta, zostanie przeniesiona do kolejki podrzędnej utraconych komunikatów.
requiresSession

Jeśli zostanie ustawiona wartość true, subskrypcja będzie mieć świadomość sesji i będzie obsługiwana tylko właściwość SessionReceiver. Subskrypcja z obsługą sesji nie jest obsługiwana za pośrednictwem interfejsu REST. Ustaw tabelę tylko w czasie tworzenia subskrypcji.
status

Stan jednostki obsługi komunikatów.
userMetadata

Użytkownik podał informacje o metadanych skojarzonych z subskrypcją. Służy do określania zawartości tekstowej, takiej jak tagi, etykiety itp. Wartość nie może przekraczać 1024 bajtów zakodowanych w formacie utf-8.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.
onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.
tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

autoDeleteOnIdle

Maksymalny czas bezczynności przed usunięciem jednostki. Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Wartość właściwości

string

availabilityStatus

Stan dostępności jednostki obsługi komunikatów.

availabilityStatus?: EntityAvailabilityStatus

Wartość właściwości

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

Określa sposób obsługi komunikatu przez usługę Service Bus, który powoduje wyjątek podczas oceny filtru subskrypcji. Jeśli wartość jest ustawiona na true, komunikat, który spowodował wyjątek, zostanie przeniesiony do kolejki podrzędnej utraconych komunikatów subskrypcji. W przeciwnym razie zostanie odrzucona. Domyślnie ten parametr ma wartość true, umożliwiając użytkownikowi możliwość zbadania przyczyny wyjątku. Może to nastąpić z źle sformułowanego komunikatu lub niektórych nieprawidłowych założeń w filtrze dotyczącym formy wiadomości. Ustaw tabelę tylko w czasie tworzenia tematu.

deadLetteringOnFilterEvaluationExceptions?: boolean

Wartość właściwości

boolean

deadLetteringOnMessageExpiration

Jeśli jest włączona, a komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki w kolejce podrzędnej subskrypcji. Jeśli ta funkcja zostanie wyłączona, komunikat zostanie trwale usunięty z głównej kolejki subskrypcji. Ustaw tabelę tylko w czasie tworzenia subskrypcji.

deadLetteringOnMessageExpiration?: boolean

Wartość właściwości

boolean

defaultMessageTimeToLive

Określa, jak długo w subskrypcji znajduje się komunikat. W zależności od tego, czy włączono wysyłanie utraconych komunikatów, których czas wygaśnięcia wygasł, zostanie przeniesiony do skojarzonej subskrypcji deadLtterQueue lub trwale usuniętej. Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Wartość właściwości

string

defaultRuleOptions

Reprezentuje opcje tworzenia reguły domyślnej dla subskrypcji.

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

Wartość właściwości

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

enableBatchedOperations

Określa, czy operacje wsadowe powinny być dozwolone.

enableBatchedOperations?: boolean

Wartość właściwości

boolean

forwardDeadLetteredMessagesTo

Bezwzględny adres URL lub nazwa kolejki lub tematu, do których mają być przekazywane komunikaty z komunikatami utraconymi. Na przykład bezwzględne dane wejściowe adresu URL będą miały postać sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Wartość właściwości

string

forwardTo

Bezwzględny adres URL lub nazwa kolejki lub tematu, do których mają być przekazywane komunikaty. Na przykład bezwzględne dane wejściowe adresu URL będą miały postać sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Wartość właściwości

string

lockDuration

Domyślny czas trwania blokady jest stosowany do subskrypcji, które nie definiują czasu trwania blokady. (Jeśli sesje są włączone, ten czas trwania blokady ma zastosowanie do sesji, a nie dla komunikatów).

Należy to określić w formacie czasu trwania ISO-8601, takim jak "PT1M" przez 1 minutę, "PT5S" przez 5 sekund.

Więcej informacji na temat formatu czasu trwania ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Wartość właściwości

string

maxDeliveryCount

Maksymalna liczba komunikatów, po których, jeśli nadal nie zostanie rozstrzygnięta, zostanie przeniesiona do kolejki podrzędnej utraconych komunikatów.

maxDeliveryCount?: number

Wartość właściwości

number

requiresSession

Jeśli zostanie ustawiona wartość true, subskrypcja będzie mieć świadomość sesji i będzie obsługiwana tylko właściwość SessionReceiver. Subskrypcja z obsługą sesji nie jest obsługiwana za pośrednictwem interfejsu REST. Ustaw tabelę tylko w czasie tworzenia subskrypcji.

requiresSession?: boolean

Wartość właściwości

boolean

status

Stan jednostki obsługi komunikatów.

status?: EntityStatus

Wartość właściwości

EntityStatus

userMetadata

Użytkownik podał informacje o metadanych skojarzonych z subskrypcją. Służy do określania zawartości tekstowej, takiej jak tagi, etykiety itp. Wartość nie może przekraczać 1024 bajtów zakodowanych w formacie utf-8.

userMetadata?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

dziedziczone zOperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

dziedziczone zOperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

dziedziczone zOperationOptions.requestOptions

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

dziedziczone zOperationOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zOperationOptions.tracingOptions