@azure/service-bus package

Klasy

MessagingError	Opisuje klasę podstawową dla błędu obsługi komunikatów.
ServiceBusAdministrationClient	Wszystkie operacje zwracają obietnice rozpoznające obiekt zawierający odpowiednie dane wyjściowe. Te obiekty mają również właściwość o nazwie _response, której można użyć, jeśli chcesz uzyskać bezpośrednią odpowiedź z usługi.
ServiceBusClient	Klient, który może tworzyć wystąpienia nadawcy do wysyłania komunikatów do kolejek i tematów, a także wystąpień odbiorcy w celu odbierania komunikatów z kolejek i subskrypcji.
ServiceBusError	Błędy występujące w usłudze Service Bus.

Interfejsy

AuthorizationRule	Reprezentuje typ AuthorizationRule w operacjach zarządzania opartych na atomach.
CorrelationRuleFilter	Reprezentuje wyrażenie filtru korelacji. Właściwość CorrelationRuleFilter zawiera zestaw warunków, które są zgodne z właściwościami użytkownika i systemu przychodzących komunikatów z subskrypcji.
CreateMessageBatchOptions	Opcje konfigurowania metody createBatch w Sender. maxSizeInBytes: górny limit rozmiaru partii. Przykładowe użycie: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Reprezentuje opcje ustawiania w kolejce
CreateSubscriptionOptions	Reprezentuje opcje ustawiania w subskrypcji
CreateTopicOptions	Reprezentuje opcje ustawiania w temacie
DeadLetterOptions	Opisuje przyczynę i opis błędu dotyczący komunikatu za pomocą metody deadLetter() odebranej z usługi Service Bus.
Delivery
GetMessageIteratorOptions	Opcje podczas uzyskiwania iteratora z usługi Service Bus.
HttpHeader	Pojedynczy nagłówek w kolekcji HttpHeaders.
HttpHeadersLike	Kolekcja par klucz/wartość nagłówka HTTP.
HttpResponse	Właściwości odpowiedzi HTTP, które będą zawsze obecne.
MessageHandlers	Ogólny interfejs obsługi komunikatów (używany dla funkcji streamMessages).
NamespaceProperties	Reprezentuje metadane związane z przestrzenią nazw usługi Service Bus.
OperationOptions	Typ opcji podstawowych dla wszystkich operacji.
PeekMessagesOptions	Opisuje opcje przekazywane do metody peekMessages w odbiorniku.
ProcessErrorArgs	Argumenty wywołania zwrotnego processError.
QueueProperties	Reprezentuje dane wejściowe dla kolejki updateQueue.
QueueRuntimeProperties	Reprezentuje atrybuty informacji o czasie wykonywania jednostki kolejki
ReceiveMessagesOptions	Opcje podczas odbierania partii komunikatów z usługi Service Bus.
RetryOptions	Opcje zasad ponawiania, które określają tryb, liczbę ponownych prób, interwał ponawiania prób itp.
RuleProperties	Reprezentuje wszystkie atrybuty reguły.
ServiceBusAdministrationClientOptions	Reprezentuje opcje klienta ServiceBusAdministrationClient.
ServiceBusClientOptions	Opisuje opcje, które można udostępnić podczas tworzenia obiektu ServiceBusClient. webSocketOptions: Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web. websocket: konstruktor Protokołu WebSocket używany do tworzenia połączenia protokołu AMQP, jeśli zdecydujesz się nawiązać połączenie za pośrednictwem protokołu WebSocket. webSocketConstructorOptions: Opcje przekazywania do konstruktora protokołu Websocket podczas wybierania połączenia za pośrednictwem protokołu WebSocket. retryOptions: opcje ponawiania dla wszystkich operacji na kliencie. maxRetries: liczba ponownych prób wykonania operacji w przypadku błędu możliwego do ponowienia próby. maxRetryDelayInMs: maksymalne opóźnienie między ponowną próbą. Dotyczy tylko podczas wykonywania ponownych prób wykładniczych. mode: który tryb ponawiania próby ma być stosowany, określony przez wyliczenie RetryMode. Opcje to Exponential i Fixed. Wartość domyślna to Fixed. retryDelayInMs: czas oczekiwania w milisekundach przed podjęciem następnej próby. Gdy mode jest ustawiona na Exponential, służy do obliczania wykładniczo rosnących opóźnień między ponownymi próbami. Wartość domyślna: 30000 milisekund. timeoutInMs: czas oczekiwania w milisekundach przed przekroczeniem limitu czasu operacji. Spowoduje to wyzwolenie ponawiania próby w przypadku pozostałych ponownych prób. Wartość minimalna: 60000 milisekund.
ServiceBusConnectionStringProperties	Zestaw właściwości składających się na parametry połączenia usługi Service Bus.
ServiceBusMessage	Opisuje komunikat, który ma zostać wysłany do usługi Service Bus.
ServiceBusMessageBatch	Partia komunikatów, które można utworzyć przy użyciu metody <xref:createBatch>.
ServiceBusReceivedMessage	Opisuje komunikat odebrany z usługi Service Bus podczas operacji wglądu i nie można go rozliczyć.
ServiceBusReceiver	Odbiornik, który nie obsługuje sesji.
ServiceBusReceiverOptions	Opcje do użycia podczas tworzenia odbiornika.
ServiceBusRuleManager	Umożliwia zarządzanie regułami subskrypcji. Ten menedżer reguł wymaga tylko oświadczeń nasłuchiwania, natomiast ServiceBusAdministrationClient wymaga zarządzania oświadczeniami.
ServiceBusSender	Nadawca może służyć do wysyłania wiadomości, planowania wysyłania komunikatów w późniejszym czasie i anulowania takich zaplanowanych komunikatów. Użyj funkcji createSender w obiekcie ServiceBusClient, aby utworzyć wystąpienie nadawcy. Klasa Sender jest abstrakcją nad bazowym linkiem nadawcy protokołu AMQP.
ServiceBusSenderOptions	Opcje do użycia podczas tworzenia nadawcy.
ServiceBusSessionReceiver	Odbiornik obsługujący sesje, w tym odnawianie blokady sesji.
ServiceBusSessionReceiverOptions	Opisuje opcje przekazywane do metod acceptSession i acceptNextSession podczas korzystania z kolejki/subskrypcji, która ma włączone sesje.
SqlRuleFilter	Reprezentuje wszystkie możliwe pola w obiekcie SqlRuleFilter
SubscribeOptions	Opcje używane podczas subskrybowania kolejki lub subskrypcji usługi Service Bus.
SubscriptionProperties	Reprezentuje dane wejściowe dla elementu updateSubscription.
SubscriptionRuntimeProperties	Reprezentuje atrybuty informacji o czasie wykonywania jednostki subskrypcji
TokenCredential	Reprezentuje poświadczenie, które może zapewnić token uwierzytelniania.
TopicProperties	Reprezentuje dane wejściowe dla updateTopic.
TopicRuntimeProperties	Reprezentuje atrybuty informacji o czasie wykonywania jednostki tematu
TryAddOptions	Zestaw opcji do ręcznego propagowania kontekstu Span na potrzeby śledzenia rozproszonego.
WebResourceLike	Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.
WebSocketImpl	Opisuje wymagany kształt konstruktorów protokołu WebSocket.
WebSocketOptions	Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.

Aliasy typu

EntitiesResponse	Reprezentuje wynik operacji listy dla jednostek, które zawierają również continuationToken do rozpoczęcia iteracji od.
EntityAvailabilityStatus	Możliwe wartości dla availabilityStatus jednostek obsługi komunikatów usługi Service Bus.
EntityStatus	Możliwe wartości dla status jednostek obsługi komunikatów usługi Service Bus.
OperationOptionsBase	UWAGA: Ten typ ma odzwierciedlać odpowiednie pola i strukturę z @azure/core-client OperationOptions Opcje konfigurowania śledzenia i abortSignal.
RawHttpHeaders	Kolekcja HttpHeaders reprezentowana jako prosty obiekt JSON.
ServiceBusErrorCode	Kody błędów usługi Service Bus.
SqlRuleAction	Reprezentuje wszystkie możliwe pola w usłudze SqlRuleAction
TransferProgressEvent	Wyzwolony w odpowiedzi na postęp przekazywania lub pobierania.
WithResponse	Reprezentuje zwróconą odpowiedź operacji wraz z nieprzetworzonym odpowiedzią.

Wyliczenia

RetryMode	Opisuje typ trybu ponawiania prób
TokenType	Opisuje typ obsługiwanych tokenów.

Funkcje

delay<T>(number, AbortSignalLike, string, T)	Otoka setTimeout, która rozwiązuje obietnicę po milisekundach.
isServiceBusError(unknown)	Określa, czy błąd jest typu ServiceBusError
parseServiceBusConnectionString(string)	Analizuje podane parametry połączenia do różnych właściwości mających zastosowanie do usługi Azure Service Bus. Właściwości są przydatne do konstruowania obiektu ServiceBusClient.

Szczegóły funkcji

delay<T>(number, AbortSignalLike, string, T)

Otoka setTimeout, która rozwiązuje obietnicę po milisekundach.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parametry

delayInMs

number

Liczba milisekund, które mają być opóźnione.

abortSignal

AbortSignalLike

AbortSignal skojarzony z zawierającą operacją.

abortErrorMsg

string

Komunikat o błędzie przerwania skojarzony z zawierającą operacją.

value

T

Wartość, która ma zostać rozpoznana po przekroczeniu limitu czasu t milisekund.

Zwraca

Promise<T | void>

• Rozwiązana obietnica

isServiceBusError(unknown)

Określa, czy błąd jest typu ServiceBusError

function isServiceBusError(err: unknown): err

Parametry

err

unknown

Błąd sprawdzania, czy jest to typ ServiceBusError

Zwraca

err

parseServiceBusConnectionString(string)

Analizuje podane parametry połączenia do różnych właściwości mających zastosowanie do usługi Azure Service Bus. Właściwości są przydatne do konstruowania obiektu ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parametry

connectionString

string

Parametry połączenia skojarzone z zasadami dostępu współdzielonego utworzone dla przestrzeni nazw, kolejki lub tematu usługi Service Bus.

Zwraca

ServiceBusConnectionStringProperties