Udostępnij za pośrednictwem

QueueProperties interface

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

Reprezentuje dane wejściowe dla kolejki aktualizacji.

Właściwości

authorizationRules

Reguły autoryzacji w kolejce
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
availabilityStatus

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

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

W zależności od tego, czy funkcja DeadLettering jest włączona, komunikat jest automatycznie przenoszony do kolejki podrzędnej utraconych komunikatów lub usuwany, jeśli jest przechowywany w kolejce przez dłuższy niż określony czas. Ta wartość jest zastępowana przez czas wygaśnięcia określony w komunikacie, jeśli i tylko wtedy, gdy czas wygaśnięcia komunikatu jest mniejszy niż czas wygaśnięcia ustawiony w kolejce. Ta wartość jest niezmienna po utworzeniu kolejki. 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
duplicateDetectionHistoryTimeWindow

Określa przedział czasu, w którym usługa Service Bus wykrywa duplikowanie 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
enableBatchedOperations

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

Określa, czy jednostki ekspresowe są włączone w kolejce.
enablePartitioning

Określa, czy kolejka powinna być partycjonowana.
forwardDeadLetteredMessagesTo

Bezwzględny adres URL lub nazwa kolejki lub tematu wiadomości utraconych mają być przekazywane do. 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

Określa czas w sekundach, w którym komunikat powinien być zablokowany do przetwarzania przez odbiornik. Po upływie tego okresu komunikat zostanie odblokowany i będzie dostępny do użycia przez następnego odbiorcy. (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 dostarczania, po których, jeśli nadal nie zostanie rozliczona, zostanie przeniesiona do kolejki podrzędnej utraconych listów.
maxMessageSizeInKilobytes

Maksymalny rozmiar komunikatu w kilobajtach dla komunikatów wysyłanych do tej kolejki.

Nie dotyczy, jeśli podczas tworzenia ServiceBusAdministrationClientprogramu wybrano wersję usługi "2017-04".
maxSizeInMegabytes

Określa maksymalny rozmiar kolejki w megabajtach. Każda próba w kolejce komunikatu, który spowoduje, że kolejka przekroczy tę wartość, zakończy się niepowodzeniem.
name

Nazwa kolejki
requiresDuplicateDetection

Jeśli to ustawienie jest włączone, temat wykryje zduplikowane komunikaty w przedziale czasu określonym przez właściwość DuplicateDetectionHistoryTimeWindow. Ustaw tabelę tylko w czasie tworzenia kolejki.
requiresSession

Jeśli zostanie ustawiona wartość true, kolejka będzie uwzględniana w sesji i będzie obsługiwana tylko parametr SessionReceiver. Kolejki obsługujące sesję nie są obsługiwane za pośrednictwem interfejsu REST. Ustaw tabelę tylko w czasie tworzenia kolejki.
status

Stan jednostki obsługi komunikatów.
userMetadata

Użytkownik podał informacje o metadanych skojarzonych z kolejką. 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

authorizationRules

Reguły autoryzacji w kolejce

authorizationRules?: AuthorizationRule[]

Wartość właściwości

AuthorizationRule[]

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

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

Jeśli jest włączona i komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki w kolejce podrzędnej. Jeśli ta funkcja zostanie wyłączona, komunikat zostanie trwale usunięty z kolejki. Ustawiana jest tylko w czasie tworzenia kolejki.

deadLetteringOnMessageExpiration: boolean

Wartość właściwości

boolean

defaultMessageTimeToLive

W zależności od tego, czy funkcja DeadLettering jest włączona, komunikat jest automatycznie przenoszony do kolejki podrzędnej utraconych komunikatów lub usuwany, jeśli jest przechowywany w kolejce przez dłuższy niż określony czas. Ta wartość jest zastępowana przez czas wygaśnięcia określony w komunikacie, jeśli i tylko wtedy, gdy czas wygaśnięcia komunikatu jest mniejszy niż czas wygaśnięcia ustawiony w kolejce. Ta wartość jest niezmienna po utworzeniu kolejki. 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

duplicateDetectionHistoryTimeWindow

Określa przedział czasu, w którym usługa Service Bus wykrywa duplikowanie 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

duplicateDetectionHistoryTimeWindow: string

Wartość właściwości

string

enableBatchedOperations

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

enableBatchedOperations: boolean

Wartość właściwości

boolean

enableExpress

Określa, czy jednostki ekspresowe są włączone w kolejce.

enableExpress: boolean

Wartość właściwości

boolean

enablePartitioning

Określa, czy kolejka powinna być partycjonowana.

enablePartitioning: boolean

Wartość właściwości

boolean

forwardDeadLetteredMessagesTo

Bezwzględny adres URL lub nazwa kolejki lub tematu wiadomości utraconych mają być przekazywane do. 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

Określa czas w sekundach, w którym komunikat powinien być zablokowany do przetwarzania przez odbiornik. Po upływie tego okresu komunikat zostanie odblokowany i będzie dostępny do użycia przez następnego odbiorcy. (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 dostarczania, po których, jeśli nadal nie zostanie rozliczona, zostanie przeniesiona do kolejki podrzędnej utraconych listów.

maxDeliveryCount: number

Wartość właściwości

number

maxMessageSizeInKilobytes

Maksymalny rozmiar komunikatu w kilobajtach dla komunikatów wysyłanych do tej kolejki.

Nie dotyczy, jeśli podczas tworzenia ServiceBusAdministrationClientprogramu wybrano wersję usługi "2017-04".

maxMessageSizeInKilobytes?: number

Wartość właściwości

number

maxSizeInMegabytes

Określa maksymalny rozmiar kolejki w megabajtach. Każda próba w kolejce komunikatu, który spowoduje, że kolejka przekroczy tę wartość, zakończy się niepowodzeniem.

maxSizeInMegabytes: number

Wartość właściwości

number

name

Nazwa kolejki

name: string

Wartość właściwości

string

requiresDuplicateDetection

Jeśli to ustawienie jest włączone, temat wykryje zduplikowane komunikaty w przedziale czasu określonym przez właściwość DuplicateDetectionHistoryTimeWindow. Ustaw tabelę tylko w czasie tworzenia kolejki.

requiresDuplicateDetection: boolean

Wartość właściwości

boolean

requiresSession

Jeśli zostanie ustawiona wartość true, kolejka będzie uwzględniana w sesji i będzie obsługiwana tylko parametr SessionReceiver. Kolejki obsługujące sesję nie są obsługiwane za pośrednictwem interfejsu REST. Ustaw tabelę tylko w czasie tworzenia kolejki.

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 kolejką. 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