SubscriptionProperties interface
Reprezentuje dane wejściowe dla elementu updateSubscription.
Właściwości
auto |
Maksymalny czas bezczynności przed usunięciem jednostki. Ma to być określone 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 |
availability |
Stan dostępności jednostki obsługi komunikatów. |
dead |
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 wartość true, komunikat, który spowodował wyjątek, zostanie przeniesiony do kolejki podrzędnej utraconych komunikatów subskrypcji. W przeciwnym razie zostanie ono odrzucone. Domyślnie ten parametr ma wartość true, co umożliwia użytkownikowi zbadanie przyczyny wyjątku. Może to nastąpić z źle sformułowanego komunikatu lub pewnych nieprawidłowych założeń w filtrze dotyczącym formy wiadomości. Ustaw tabelę tylko w czasie tworzenia tematu. |
dead |
Jeśli jest włączona i komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki utraconych komunikatów 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. |
default |
Określa, jak długo komunikat znajduje się w subskrypcji. W zależności od tego, czy włączono obsługę utraconych komunikatów, wiadomość, której czas wygaśnięcia wygasł, zostanie przeniesiona do skojarzonej subskrypcji DeadLtterQueue lub trwale usuniętej. Ma to być określone 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 |
enable |
Określa, czy operacje wsadowe powinny być dozwolone. |
forward |
Bezwzględny adres URL lub nazwa kolejki lub tematu, do których mają być przekazywane komunikaty utraconych wiadomości.
Na przykład bezwzględne dane wejściowe adresu URL będą mieć postać |
forward |
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ą mieć postać |
lock |
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). Ma to być określone 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 |
max |
Maksymalna liczba komunikatów, po których, jeśli nadal nie zostanie rozliczona, zostanie przeniesiona do kolejki podrzędnej utraconych komunikatów. |
requires |
W przypadku ustawienia wartości true subskrypcja będzie uwzględniana w 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. |
subscription |
Nazwa subskrypcji |
topic |
Nazwa tematu |
user |
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. |
Szczegóły właściwości
autoDeleteOnIdle
Maksymalny czas bezczynności przed usunięciem jednostki. Ma to być określone 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
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 wartość true, komunikat, który spowodował wyjątek, zostanie przeniesiony do kolejki podrzędnej utraconych komunikatów subskrypcji. W przeciwnym razie zostanie ono odrzucone. Domyślnie ten parametr ma wartość true, co umożliwia użytkownikowi zbadanie przyczyny wyjątku. Może to nastąpić z źle sformułowanego komunikatu lub pewnych 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 i komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki utraconych komunikatów 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 komunikat znajduje się w subskrypcji. W zależności od tego, czy włączono obsługę utraconych komunikatów, wiadomość, której czas wygaśnięcia wygasł, zostanie przeniesiona do skojarzonej subskrypcji DeadLtterQueue lub trwale usuniętej. Ma to być określone 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
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 utraconych wiadomości.
Na przykład bezwzględne dane wejściowe adresu URL będą mieć 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ą mieć 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).
Ma to być określone 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 rozliczona, zostanie przeniesiona do kolejki podrzędnej utraconych komunikatów.
maxDeliveryCount: number
Wartość właściwości
number
requiresSession
W przypadku ustawienia wartości true subskrypcja będzie uwzględniana w 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
subscriptionName
Nazwa subskrypcji
subscriptionName: string
Wartość właściwości
string
topicName
Nazwa tematu
topicName: string
Wartość właściwości
string
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