Udostępnij za pośrednictwem

CreateQueueOptions interface

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

Reprezentuje opcje ustawiania w kolejce

Extends
OperationOptions

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. 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
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 ma być partycjonowana.
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>
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>
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ępny odbiornik. (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
maxDeliveryCount

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

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

(Można konfigurować tylko dla przestrzeni nazw usługi Service Bus w warstwie Premium).
maxSizeInMegabytes

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

Jeśli to ustawienie jest włączone, temat wykryje zduplikowane komunikaty w przedziale czasu określonym przez właściwość DuplicateDetectionHistoryTimeWindow. Ustawiana jest 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 właściwość SessionReceiver. Kolejki obsługujące sesję nie są obsługiwane za pośrednictwem interfejsu REST. Ustawiana jest 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.

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 jest włączone.

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. 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?: 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 ma być partycjonowana.

enablePartitioning?: 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

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ępny odbiornik. (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

maxMessageSizeInKilobytes

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

(Można konfigurować tylko dla przestrzeni nazw usługi Service Bus w warstwie Premium).

maxMessageSizeInKilobytes?: number

Wartość właściwości

number

maxSizeInMegabytes

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

maxSizeInMegabytes?: number

Wartość właściwości

number

requiresDuplicateDetection

Jeśli to ustawienie jest włączone, temat wykryje zduplikowane komunikaty w przedziale czasu określonym przez właściwość DuplicateDetectionHistoryTimeWindow. Ustawiana jest 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 właściwość SessionReceiver. Kolejki obsługujące sesję nie są obsługiwane za pośrednictwem interfejsu REST. Ustawiana jest 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

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 zelementu OperationOptions.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 jest włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone zoperationOptions.tracingOptions