Dela via

ServiceBusClient class

Paket:
@azure/service-bus

En klient som kan skapa avsändarinstanser för att skicka meddelanden till köer och ämnen samt mottagarinstanser för att ta emot meddelanden från köer och prenumerationer.

Konstruktorer

ServiceBusClient(string, ServiceBusClientOptions)

Skapar en instans av klassen ServiceBusClient som kan användas för att skapa avsändare och mottagare till Azure Service Bus-namnområdet som anges i anslutningssträngen. Ingen anslutning görs till tjänsten förrän avsändare/mottagare som skapats med klienten används för att skicka/ta emot meddelanden.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Skapar en instans av klassen ServiceBusClient som kan användas för att skapa avsändare och mottagare till det angivna Azure Service Bus-namnområdet. Ingen anslutning görs till tjänsten förrän avsändare/mottagare som skapats med klienten används för att skicka/ta emot meddelanden.

Egenskaper

fullyQualifiedNamespace

Det fullständigt kvalificerade namnområdet för Den Service Bus-instans som klienten har skapats för. Detta kommer sannolikt att likna <yournamespace.servicebus.windows.net>.
identifier

Namnet som används för att identifiera denna ServiceBusClient. Om det inte anges eller är tomt genereras en slumpmässig unik.

Metoder

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för nästa tillgängliga session i en sessionsaktiverad Azure Service Bus-kö.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för nästa tillgängliga session i en sessionsaktiverad Azure Service Bus-prenumeration.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för en sessionsaktiverad Azure Service Bus-kö.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för en sessionsaktiverad Azure Service Bus-prenumeration.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Stänger den underliggande AMQP-anslutningen. Obs! Detta kopplar också från alla mottagare eller avsändare som skapats från den här instansen.
createReceiver(string, ServiceBusReceiverOptions)

Skapar en mottagare för en Azure Service Bus-kö. Ingen anslutning görs till tjänsten förrän någon av metoderna på mottagaren anropas.

Ange subQueue i alternativen om du vill rikta in dig på underköer som kön med obeställbara meddelanden eller kön för överföring av obeställbara meddelanden. Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Meddelanden som inte har lösts inom låsets varaktighet levereras på nytt så många gånger som det maximala leveransantalet anges i kön, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)

Skapar en mottagare för en Azure Service Bus-prenumeration. Ingen anslutning görs till tjänsten förrän någon av metoderna på mottagaren anropas.

Ange subQueue i alternativen om du vill rikta in dig på underköer som kön med obeställbara meddelanden eller kön för överföring av obeställbara meddelanden. Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Meddelanden som inte har lösts inom låsets varaktighet levereras på nytt så många gånger som det maximala leveransantalet har angetts för prenumerationen, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)

Skapar en instans av ServiceBusRuleManager- som används för att hantera reglerna för en prenumeration.
createSender(string, ServiceBusSenderOptions)

Skapar en avsändare som kan användas för att skicka meddelanden, schemalägga meddelanden som ska skickas vid ett senare tillfälle och avbryta sådana schemalagda meddelanden. Ingen anslutning görs till tjänsten förrän någon av metoderna på avsändaren anropas.

Konstruktorinformation

ServiceBusClient(string, ServiceBusClientOptions)

Skapar en instans av klassen ServiceBusClient som kan användas för att skapa avsändare och mottagare till Azure Service Bus-namnområdet som anges i anslutningssträngen. Ingen anslutning görs till tjänsten förrän avsändare/mottagare som skapats med klienten används för att skicka/ta emot meddelanden.

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

Parametrar

connectionString

string

En anslutningssträng för Azure Service Bus-namnområdet. Obs! Den här anslutningssträngen kan innehålla en EntityPath som ignoreras.

options
ServiceBusClientOptions

Alternativ för Service Bus-klienten.

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

Skapar en instans av klassen ServiceBusClient som kan användas för att skapa avsändare och mottagare till det angivna Azure Service Bus-namnområdet. Ingen anslutning görs till tjänsten förrän avsändare/mottagare som skapats med klienten används för att skicka/ta emot meddelanden.

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

Parametrar

fullyQualifiedNamespace

string

Det fullständiga namnområdet för din Service Bus-instans som troligen liknar <yournamespace.servicebus.windows.net>.

credential

TokenCredential | NamedKeyCredential | SASCredential

Ett autentiseringsobjekt som används av klienten för att hämta token för att autentisera anslutningen till Azure Service Bus. Se @azure/identitet för att skapa autentiseringsuppgifterna. Om du använder en egen implementering av TokenCredential-gränssnittet mot AAD anger du "omfången" för service-bus som ["https://servicebus.azure.net//user_impersonation"] för att hämta rätt token. Använd AzureNamedKeyCredential från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Fälten mappas till fältet name respektive key i AzureNamedKeyCredential. Använd AzureSASCredential från @azure/core-auth om du vill skicka in en SharedAccessSignature utan att använda en anslutningssträng. Det här fältet mappar till signature i AzureSASCredential.

options
ServiceBusClientOptions

En uppsättning alternativ som ska användas när klienten konfigureras.

  • retryOptions : Konfigurerar återförsöksprincipen för alla åtgärder på klienten. Till exempel { "maxRetries": 4 } eller { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Konfigurerar kanalisering av AMQP-anslutningen via Web Sockets.

Egenskapsinformation

fullyQualifiedNamespace

Det fullständigt kvalificerade namnområdet för Den Service Bus-instans som klienten har skapats för. Detta kommer sannolikt att likna <yournamespace.servicebus.windows.net>.

fullyQualifiedNamespace: string

Egenskapsvärde

string

identifier

Namnet som används för att identifiera denna ServiceBusClient. Om det inte anges eller är tomt genereras en slumpmässig unik.

identifier: string

Egenskapsvärde

string

Metodinformation

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för nästa tillgängliga session i en sessionsaktiverad Azure Service Bus-kö.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametrar

queueName

string

Namnet på kön som ska ta emot från.

options
ServiceBusSessionReceiverOptions

Alternativen inkluderar receiveMode (standard för peekLock), alternativ för att skapa sessionsmottagare.

Returer

Promise<ServiceBusSessionReceiver>

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för nästa tillgängliga session i en sessionsaktiverad Azure Service Bus-prenumeration.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametrar

topicName

string

Namnet på ämnet för den prenumeration som vi vill ta emot från.

subscriptionName

string

Namnet på den prenumeration (under topic) som vi vill ta emot från.

options
ServiceBusSessionReceiverOptions

Alternativen inkluderar receiveMode (standard för peekLock), alternativ för att skapa sessionsmottagare.

Returer

Promise<ServiceBusSessionReceiver>

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för en sessionsaktiverad Azure Service Bus-kö.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametrar

queueName

string

Namnet på kön som ska ta emot från.

sessionId

string

ID för sessionen som meddelanden måste tas emot från

options
ServiceBusSessionReceiverOptions

Alternativen inkluderar receiveMode (standard för peekLock), alternativ för att skapa sessionsmottagare.

Returer

Promise<ServiceBusSessionReceiver>

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Skapar en mottagare för en sessionsaktiverad Azure Service Bus-prenumeration.

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: 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>

Parametrar

topicName

string

Namnet på ämnet för den prenumeration som vi vill ta emot från.

subscriptionName

string

Namnet på den prenumeration (under topic) som vi vill ta emot från.

sessionId

string

ID för sessionen som meddelanden måste tas emot från

options
ServiceBusSessionReceiverOptions

Alternativen inkluderar receiveMode (standard för peekLock), alternativ för att skapa sessionsmottagare.

Returer

Promise<ServiceBusSessionReceiver>

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

close()

Stänger den underliggande AMQP-anslutningen. Obs! Detta kopplar också från alla mottagare eller avsändare som skapats från den här instansen.

function close(): Promise<void>

Returer

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Skapar en mottagare för en Azure Service Bus-kö. Ingen anslutning görs till tjänsten förrän någon av metoderna på mottagaren anropas.

Ange subQueue i alternativen om du vill rikta in dig på underköer som kön med obeställbara meddelanden eller kön för överföring av obeställbara meddelanden. Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Meddelanden som inte har lösts inom låsets varaktighet levereras på nytt så många gånger som det maximala leveransantalet anges i kön, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametrar

queueName

string

Namnet på kön som ska ta emot från.

options
ServiceBusReceiverOptions

Alternativ för att skicka receiveMode, som standard för peekLock.

Returer

ServiceBusReceiver

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

createReceiver(string, string, ServiceBusReceiverOptions)

Skapar en mottagare för en Azure Service Bus-prenumeration. Ingen anslutning görs till tjänsten förrän någon av metoderna på mottagaren anropas.

Ange subQueue i alternativen om du vill rikta in dig på underköer som kön med obeställbara meddelanden eller kön för överföring av obeställbara meddelanden. Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Du kan välja mellan två mottagningslägen: "peekLock" (standard) och "receiveAndDelete".

  • I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön.
  • I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

Meddelanden som inte har lösts inom låsets varaktighet levereras på nytt så många gånger som det maximala leveransantalet har angetts för prenumerationen, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoden completeMessage(), abandonMessage(), deferMessage() eller deadletterMessage() på mottagaren.

Mer information om hur peekLock och meddelandebosättning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parametrar

topicName

string

Namnet på ämnet för den prenumeration som vi vill ta emot från.

subscriptionName

string

Namnet på den prenumeration (under topic) som vi vill ta emot från.

options
ServiceBusReceiverOptions

Alternativ för att skicka receiveMode, som standard för peekLock.

Returer

ServiceBusReceiver

En mottagare som kan användas för att ta emot, granska och reglera meddelanden.

createRuleManager(string, string)

Skapar en instans av ServiceBusRuleManager- som används för att hantera reglerna för en prenumeration.

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

Parametrar

topicName

string

ämnet för att skapa ServiceBusRuleManager

subscriptionName

string

prenumerationen som är specifik för det angivna ämnet för att skapa en ServiceBusRuleManager- för.

Returer

ServiceBusRuleManager

a ServiceBusRuleManager begränsad till den angivna prenumerationen och ämnet.

createSender(string, ServiceBusSenderOptions)

Skapar en avsändare som kan användas för att skicka meddelanden, schemalägga meddelanden som ska skickas vid ett senare tillfälle och avbryta sådana schemalagda meddelanden. Ingen anslutning görs till tjänsten förrän någon av metoderna på avsändaren anropas.

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

Parametrar

queueOrTopicName

string

Namnet på en kö eller ett ämne som meddelanden ska skickas till.

options
ServiceBusSenderOptions

Returer

ServiceBusSender