ServiceBusClient class

Pakiet:

@azure/service-bus

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.

Konstruktory

ServiceBusClient(string, ServiceBusClientOptions)	Tworzy wystąpienie klasy ServiceBusClient, które może służyć do tworzenia nadawców i odbiorników w przestrzeni nazw usługi Azure Service Bus podanej w parametrach połączenia. Połączenie z usługą nie zostanie nawiązane, dopóki nadawcy/odbiorcy utworzone za pomocą klienta nie będą używane do wysyłania/odbierania komunikatów.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Tworzy wystąpienie klasy ServiceBusClient, które może służyć do tworzenia nadawców i odbiorców w udostępnionej przestrzeni nazw usługi Azure Service Bus. Połączenie z usługą nie zostanie nawiązane, dopóki nadawcy/odbiorcy utworzone za pomocą klienta nie będą używane do wysyłania/odbierania komunikatów.

Właściwości

fullyQualifiedNamespace	W pełni kwalifikowana przestrzeń nazw wystąpienia usługi Service Bus, dla którego jest tworzony ten klient. Prawdopodobnie będzie to podobne do .servicebus.windows.net.
identifier	Nazwa używana do identyfikowania tego elementu ServiceBusClient. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.

Metody

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Tworzy odbiornik dla następnej dostępnej sesji w kolejce usługi Azure Service Bus z włączoną obsługą sesji. Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Tworzy odbiornik dla następnej dostępnej sesji w ramach subskrypcji usługi Azure Service Bus z obsługą sesji. Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Tworzy odbiornik dla kolejki usługi Azure Service Bus z włączoną obsługą sesji. Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Tworzy odbiornik dla sesji z włączoną subskrypcją usługi Azure Service Bus. Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Zamyka bazowe połączenie AMQP. UWAGA: spowoduje to również rozłączenie wszystkich wystąpień odbiorcy lub nadawcy utworzonych z tego wystąpienia.
createReceiver(string, ServiceBusReceiverOptions)	Tworzy odbiornik dla kolejki usługi Azure Service Bus. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod odbiornika. Aby zakierować kolejki podrzędne, takie jak kolejka utraconych komunikatów lub kolejka utraconych komunikatów, podaj subQueue w opcjach. Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, zostaną ponownie przekazane wielokrotnie, gdy maksymalna liczba dostaw ustawiona w kolejce, po czym zostaną wysłane do oddzielnej kolejki utraconych komunikatów. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Tworzy odbiornik dla subskrypcji usługi Azure Service Bus. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod odbiornika. Aby zakierować kolejki podrzędne, takie jak kolejka utraconych komunikatów lub kolejka utraconych komunikatów, podaj subQueue w opcjach. Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete". W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce. W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania. Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, zostaną ponownie wyświetlone wielokrotnie niż maksymalna liczba dostaw ustawiona w subskrypcji, po czym zostaną wysłane do oddzielnej kolejki utraconych wiadomości. Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku. Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Tworzy wystąpienie ServiceBusRuleManager używane do zarządzania regułami subskrypcji.
createSender(string, ServiceBusSenderOptions)	Tworzy nadawcę, który może służyć do wysyłania komunikatów, planowania wysyłania komunikatów w późniejszym czasie i anulowania takich zaplanowanych wiadomości. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod nadawcy.

Szczegóły konstruktora

ServiceBusClient(string, ServiceBusClientOptions)

Tworzy wystąpienie klasy ServiceBusClient, które może służyć do tworzenia nadawców i odbiorników w przestrzeni nazw usługi Azure Service Bus podanej w parametrach połączenia. Połączenie z usługą nie zostanie nawiązane, dopóki nadawcy/odbiorcy utworzone za pomocą klienta nie będą używane do wysyłania/odbierania komunikatów.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Parametry

connectionString

string

Parametry połączenia dla przestrzeni nazw usługi Azure Service Bus. UWAGA: te parametry połączenia mogą zawierać element EntityPath, który jest ignorowany.

options

ServiceBusClientOptions

Opcje klienta usługi Service Bus.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Tworzy wystąpienie klasy ServiceBusClient, które może służyć do tworzenia nadawców i odbiorców w udostępnionej przestrzeni nazw usługi Azure Service Bus. Połączenie z usługą nie zostanie nawiązane, dopóki nadawcy/odbiorcy utworzone za pomocą klienta nie będą używane do wysyłania/odbierania komunikatów.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Parametry

fullyQualifiedNamespace

string

Pełna przestrzeń nazw wystąpienia usługi Service Bus, która prawdopodobnie będzie podobna do .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Obiekt poświadczeń używany przez klienta do uzyskania tokenu w celu uwierzytelnienia połączenia z usługą Azure Service Bus. Aby utworzyć poświadczenia, zobacz @azure/tożsamość. Jeśli używasz własnej implementacji interfejsu TokenCredential względem usługi AAD, ustaw wartość "zakresy" dla usługi Service-Bus na ["https://servicebus.azure.net//user_impersonation"], aby uzyskać odpowiedni token. Użyj AzureNamedKeyCredential z uwierzytelniania @azure/core-auth, jeśli chcesz przekazać SharedAccessKeyName i SharedAccessKey bez użycia parametrów połączenia. Te pola są mapowanie odpowiednio na pola name i key w AzureNamedKeyCredential. Użyj AzureSASCredential z @azure/core-auth, jeśli chcesz przekazać SharedAccessSignature bez używania parametrów połączenia. To pole mapuje signature w AzureSASCredential.

options

ServiceBusClientOptions

Zestaw opcji do zastosowania podczas konfigurowania klienta.

• retryOptions: konfiguruje zasady ponawiania dla wszystkich operacji na kliencie. Na przykład { "maxRetries": 4 } lub { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: konfiguruje kanał połączenia AMQP za pośrednictwem gniazd sieci Web.

Szczegóły właściwości

fullyQualifiedNamespace

W pełni kwalifikowana przestrzeń nazw wystąpienia usługi Service Bus, dla którego jest tworzony ten klient. Prawdopodobnie będzie to podobne do .servicebus.windows.net.

fullyQualifiedNamespace: string

Wartość właściwości

string

identifier

Nazwa używana do identyfikowania tego elementu ServiceBusClient. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.

identifier: string

Wartość właściwości

string

Szczegóły metody

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Tworzy odbiornik dla następnej dostępnej sesji w kolejce usługi Azure Service Bus z włączoną obsługą sesji.

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametry

queueName

string

Nazwa kolejki do odebrania.

options

ServiceBusSessionReceiverOptions

Opcje obejmują metodę receiveMode (domyślną wartością podgląduLock), opcje tworzenia odbiornika sesji.

Zwraca

Promise<ServiceBusSessionReceiver>

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Tworzy odbiornik dla następnej dostępnej sesji w ramach subskrypcji usługi Azure Service Bus z obsługą sesji.

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametry

topicName

string

Nazwa tematu subskrypcji, z której chcesz otrzymywać dane.

subscriptionName

string

Nazwa subskrypcji (w ramach topic), z której chcemy otrzymywać dane.

options

ServiceBusSessionReceiverOptions

Opcje obejmują metodę receiveMode (domyślną wartością podgląduLock), opcje tworzenia odbiornika sesji.

Zwraca

Promise<ServiceBusSessionReceiver>

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Tworzy odbiornik dla kolejki usługi Azure Service Bus z włączoną obsługą sesji.

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametry

queueName

string

Nazwa kolejki do odebrania.

sessionId

string

Identyfikator sesji, z której muszą zostać odebrane komunikaty

options

ServiceBusSessionReceiverOptions

Opcje obejmują metodę receiveMode (domyślną wartością podgląduLock), opcje tworzenia odbiornika sesji.

Zwraca

Promise<ServiceBusSessionReceiver>

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Tworzy odbiornik dla sesji z włączoną subskrypcją usługi Azure Service Bus.

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametry

topicName

string

Nazwa tematu subskrypcji, z której chcesz otrzymywać dane.

subscriptionName

string

Nazwa subskrypcji (w ramach topic), z której chcemy otrzymywać dane.

sessionId

string

Identyfikator sesji, z której muszą zostać odebrane komunikaty

options

ServiceBusSessionReceiverOptions

Opcje obejmują metodę receiveMode (domyślną wartością podgląduLock), opcje tworzenia odbiornika sesji.

Zwraca

Promise<ServiceBusSessionReceiver>

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

close()

Zamyka bazowe połączenie AMQP. UWAGA: spowoduje to również rozłączenie wszystkich wystąpień odbiorcy lub nadawcy utworzonych z tego wystąpienia.

function close(): Promise<void>

Zwraca

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Tworzy odbiornik dla kolejki usługi Azure Service Bus. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod odbiornika.

Aby zakierować kolejki podrzędne, takie jak kolejka utraconych komunikatów lub kolejka utraconych komunikatów, podaj subQueue w opcjach. Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, zostaną ponownie przekazane wielokrotnie, gdy maksymalna liczba dostaw ustawiona w kolejce, po czym zostaną wysłane do oddzielnej kolejki utraconych komunikatów.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametry

queueName

string

Nazwa kolejki do odebrania.

options

ServiceBusReceiverOptions

Opcje przekazywania elementu receiveMode domyślnie są wyświetlane jako zaglądane.

Zwraca

ServiceBusReceiver

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

createReceiver(string, string, ServiceBusReceiverOptions)

Tworzy odbiornik dla subskrypcji usługi Azure Service Bus. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod odbiornika.

Aby zakierować kolejki podrzędne, takie jak kolejka utraconych komunikatów lub kolejka utraconych komunikatów, podaj subQueue w opcjach. Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Można wybrać między dwoma trybami odbierania: "peekLock" (ustawienie domyślne) i "receiveAndDelete".

• W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce.
• W trybie receiveAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, zostaną ponownie wyświetlone wielokrotnie niż maksymalna liczba dostaw ustawiona w subskrypcji, po czym zostaną wysłane do oddzielnej kolejki utraconych wiadomości.

Komunikat można rozstrzygnąć, wywołując metody completeMessage(), abandonMessage(), deferMessage() lub deadletterMessage() w odbiorniku.

Więcej informacji na temat działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametry

topicName

string

Nazwa tematu subskrypcji, z której chcesz otrzymywać dane.

subscriptionName

string

Nazwa subskrypcji (w ramach topic), z której chcemy otrzymywać dane.

options

ServiceBusReceiverOptions

Opcje przekazywania elementu receiveMode domyślnie są wyświetlane jako zaglądane.

Zwraca

ServiceBusReceiver

Odbiornik, który może służyć do odbierania, wglądu i rozliczania komunikatów.

createRuleManager(string, string)

Tworzy wystąpienie ServiceBusRuleManager używane do zarządzania regułami subskrypcji.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Parametry

topicName

string

temat tworzenia ServiceBusRuleManager

subscriptionName

string

subskrypcja specyficzna dla określonego tematu w celu utworzenia ServiceBusRuleManager dla.

Zwraca

ServiceBusRuleManager

ServiceBusRuleManager o określonym zakresie dla określonej subskrypcji i tematu.

createSender(string, ServiceBusSenderOptions)

Tworzy nadawcę, który może służyć do wysyłania komunikatów, planowania wysyłania komunikatów w późniejszym czasie i anulowania takich zaplanowanych wiadomości. Połączenie z usługą nie jest wykonywane do momentu wywołania jednej z metod nadawcy.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Parametry

queueOrTopicName

string

Nazwa kolejki lub tematu do wysyłania komunikatów.

options

ServiceBusSenderOptions

Zwraca

ServiceBusSender