ServiceBusClient class

Paket:

@azure/service-bus

Ein Client, der Absenderinstanzen zum Senden von Nachrichten an Warteschlangen und Themen sowie Empfängerinstanzen zum Empfangen von Nachrichten aus Warteschlangen und Abonnements erstellen kann.

Konstruktoren

ServiceBusClient(string, ServiceBusClientOptions)	Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern im Azure Service Bus-Namespace verwendet werden kann, der in der Verbindungszeichenfolge bereitgestellt wird. Es wird keine Verbindung mit dem Dienst hergestellt, bis die mit dem Client erstellten Absender/Empfänger zum Senden/Empfangen von Nachrichten verwendet werden.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern im bereitgestellten Azure Service Bus-Namespace verwendet werden kann. Es wird keine Verbindung mit dem Dienst hergestellt, bis die mit dem Client erstellten Absender/Empfänger zum Senden/Empfangen von Nachrichten verwendet werden.

Eigenschaften

fullyQualifiedNamespace	Der vollqualifizierte Namespace der Service Bus-Instanz, für die dieser Client erstellt wird. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar.
identifier	Der Name, der verwendet wird, um diesen ServiceBusClient zu identifizieren. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert.

Methoden

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Erstellt einen Empfänger für die nächste verfügbare Sitzung in einer sitzungsfähigen Azure Service Bus-Warteschlange. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	Erstellt einen Empfänger für die nächste verfügbare Sitzung in einem sitzungsfähigen Azure Service Bus-Abonnement. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	Erstellt einen Empfänger für eine sitzungsfähige Azure Service Bus-Warteschlange. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	Erstellt einen Empfänger für ein Sitzungsaktiviertes Azure Service Bus-Abonnement. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	Schließt die zugrunde liegende AMQP-Verbindung. HINWEIS: Dadurch werden auch alle Empfänger- oder Absenderinstanzen getrennt, die von dieser Instanz erstellt wurden.
createReceiver(string, ServiceBusReceiverOptions)	Erstellt einen Empfänger für eine Azure Service Bus-Warteschlange. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Empfänger aufgerufen wird. Geben Sie die subQueue in den Optionen an, um Unterwarteschlangen wie die Warteschlange für inaktive Briefe oder die Warteschlange für die Übertragung in tote Buchstaben abzuzielen. Weitere Informationen zu Warteschlangen mit toten Buchstaben finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die in der Warteschlange festgelegte maximale Zustellungsanzahl erneut gesendet, nach der sie an eine separate Warteschlange für tote Briefe gesendet werden. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Erstellt einen Empfänger für ein Azure Service Bus-Abonnement. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Empfänger aufgerufen wird. Geben Sie die subQueue in den Optionen an, um Unterwarteschlangen wie die Warteschlange für inaktive Briefe oder die Warteschlange für die Übertragung in tote Buchstaben abzuzielen. Weitere Informationen zu Warteschlangen mit toten Buchstaben finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete". Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer. Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht. Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für das Abonnement festgelegte maximale Zustellungsanzahl erneut gesendet, nach der sie an eine separate Warteschlange für tote Briefe gesendet werden. Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen. Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	Erstellt eine Instanz von ServiceBusRuleManager, die zum Verwalten der Regeln für ein Abonnement verwendet wird.
createSender(string, ServiceBusSenderOptions)	Erstellt einen Absender, der verwendet werden kann, um Nachrichten zu senden, nachrichten zu einem späteren Zeitpunkt zu senden und solche geplanten Nachrichten abzubrechen. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Absender aufgerufen wird.

Details zum Konstruktor

ServiceBusClient(string, ServiceBusClientOptions)

Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern im Azure Service Bus-Namespace verwendet werden kann, der in der Verbindungszeichenfolge bereitgestellt wird. Es wird keine Verbindung mit dem Dienst hergestellt, bis die mit dem Client erstellten Absender/Empfänger zum Senden/Empfangen von Nachrichten verwendet werden.

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

Parameter

connectionString

string

Eine Verbindungszeichenfolge für den Azure Service Bus-Namespace. HINWEIS: Diese Verbindungszeichenfolge kann einen EntityPath enthalten, der ignoriert wird.

options

ServiceBusClientOptions

Optionen für den Servicebusclient.

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

Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern im bereitgestellten Azure Service Bus-Namespace verwendet werden kann. Es wird keine Verbindung mit dem Dienst hergestellt, bis die mit dem Client erstellten Absender/Empfänger zum Senden/Empfangen von Nachrichten verwendet werden.

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

Parameter

fullyQualifiedNamespace

string

Der vollständige Namespace Ihrer Service Bus-Instanz, der wahrscheinlich mit .servicebus.windows.net vergleichbar ist.

credential

TokenCredential | NamedKeyCredential | SASCredential

Ein anmeldeinformationsobjekt, das vom Client verwendet wird, um das Token abzurufen, um die Verbindung mit dem Azure Service Bus zu authentifizieren. Informationen zum Erstellen der Anmeldeinformationen finden Sie unter @azure/Identität. Wenn Sie eine eigene Implementierung der TokenCredential-Schnittstelle für AAD verwenden, legen Sie die "Bereiche" für service-bus so fest, dass sie ["https://servicebus.azure.net//user_impersonation"] werden, um das entsprechende Token abzurufen. Verwenden Sie die AzureNamedKeyCredential aus @azure/Core-Auth, wenn Sie eine SharedAccessKeyName und SharedAccessKey ohne Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem feld name bzw. key feld in AzureNamedKeyCredentialzugeordnet. Verwenden Sie die AzureSASCredential aus @azure/core-auth, wenn Sie eine SharedAccessSignature ohne Verbindungszeichenfolge übergeben möchten. Dieses Feld ist in AzureSASCredentialsignature zugeordnet.

options

ServiceBusClientOptions

Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.

• retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Beispiel: { "maxRetries": 4 } oder { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfiguriert die Kanalierung der AMQP-Verbindung über Web Sockets.

Details zur Eigenschaft

fullyQualifiedNamespace

Der vollqualifizierte Namespace der Service Bus-Instanz, für die dieser Client erstellt wird. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar.

fullyQualifiedNamespace: string

Eigenschaftswert

string

identifier

Der Name, der verwendet wird, um diesen ServiceBusClient zu identifizieren. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert.

identifier: string

Eigenschaftswert

string

Details zur Methode

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Erstellt einen Empfänger für die nächste verfügbare Sitzung in einer sitzungsfähigen Azure Service Bus-Warteschlange.

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameter

queueName

string

Der Name der Warteschlange, von der empfangen werden soll.

options

ServiceBusSessionReceiverOptions

Zu den Optionen gehören receiveMode(defaulted to peekLock), Optionen zum Erstellen des Sitzungsempfängers.

Gibt zurück

Promise<ServiceBusSessionReceiver>

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Erstellt einen Empfänger für die nächste verfügbare Sitzung in einem sitzungsfähigen Azure Service Bus-Abonnement.

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameter

topicName

string

Name des Themas für das Abonnement, von dem wir empfangen möchten.

subscriptionName

string

Name des Abonnements (unter dem topic), von dem wir empfangen möchten.

options

ServiceBusSessionReceiverOptions

Zu den Optionen gehören receiveMode(defaulted to peekLock), Optionen zum Erstellen des Sitzungsempfängers.

Gibt zurück

Promise<ServiceBusSessionReceiver>

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Erstellt einen Empfänger für eine sitzungsfähige Azure Service Bus-Warteschlange.

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameter

queueName

string

Der Name der Warteschlange, von der empfangen werden soll.

sessionId

string

Die ID der Sitzung, von der Nachrichten empfangen werden müssen

options

ServiceBusSessionReceiverOptions

Zu den Optionen gehören receiveMode(defaulted to peekLock), Optionen zum Erstellen des Sitzungsempfängers.

Gibt zurück

Promise<ServiceBusSessionReceiver>

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Erstellt einen Empfänger für ein Sitzungsaktiviertes Azure Service Bus-Abonnement.

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: 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>

Parameter

topicName

string

Name des Themas für das Abonnement, von dem wir empfangen möchten.

subscriptionName

string

Name des Abonnements (unter dem topic), von dem wir empfangen möchten.

sessionId

string

Die ID der Sitzung, von der Nachrichten empfangen werden müssen

options

ServiceBusSessionReceiverOptions

Zu den Optionen gehören receiveMode(defaulted to peekLock), Optionen zum Erstellen des Sitzungsempfängers.

Gibt zurück

Promise<ServiceBusSessionReceiver>

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

close()

Schließt die zugrunde liegende AMQP-Verbindung. HINWEIS: Dadurch werden auch alle Empfänger- oder Absenderinstanzen getrennt, die von dieser Instanz erstellt wurden.

function close(): Promise<void>

Gibt zurück

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Erstellt einen Empfänger für eine Azure Service Bus-Warteschlange. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Empfänger aufgerufen wird.

Geben Sie die subQueue in den Optionen an, um Unterwarteschlangen wie die Warteschlange für inaktive Briefe oder die Warteschlange für die Übertragung in tote Buchstaben abzuzielen. Weitere Informationen zu Warteschlangen mit toten Buchstaben finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die in der Warteschlange festgelegte maximale Zustellungsanzahl erneut gesendet, nach der sie an eine separate Warteschlange für tote Briefe gesendet werden.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameter

queueName

string

Der Name der Warteschlange, von der empfangen werden soll.

options

ServiceBusReceiverOptions

Optionen zum Übergeben des receiveMode-Modus, standardmäßig als peekLock festgelegt.

Gibt zurück

ServiceBusReceiver

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

createReceiver(string, string, ServiceBusReceiverOptions)

Erstellt einen Empfänger für ein Azure Service Bus-Abonnement. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Empfänger aufgerufen wird.

Geben Sie die subQueue in den Optionen an, um Unterwarteschlangen wie die Warteschlange für inaktive Briefe oder die Warteschlange für die Übertragung in tote Buchstaben abzuzielen. Weitere Informationen zu Warteschlangen mit toten Buchstaben finden Sie unter https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".

• Im PeekLock-Modus verfügt der Empfänger über eine Sperre für die in der Warteschlange angegebene Dauer.
• Im ReceiveAndDelete-Modus werden Nachrichten beim Empfang aus service bus gelöscht.

Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für das Abonnement festgelegte maximale Zustellungsanzahl erneut gesendet, nach der sie an eine separate Warteschlange für tote Briefe gesendet werden.

Sie können eine Nachricht begleichen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() für den Empfänger aufrufen.

Weitere Informationen dazu, wie peekLock und Message Settlement hier funktionieren: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parameter

topicName

string

Name des Themas für das Abonnement, von dem wir empfangen möchten.

subscriptionName

string

Name des Abonnements (unter dem topic), von dem wir empfangen möchten.

options

ServiceBusReceiverOptions

Optionen zum Übergeben des receiveMode-Modus, standardmäßig als peekLock festgelegt.

Gibt zurück

ServiceBusReceiver

Ein Empfänger, der zum Empfangen, Anzeigen und Abgleichen von Nachrichten verwendet werden kann.

createRuleManager(string, string)

Erstellt eine Instanz von ServiceBusRuleManager, die zum Verwalten der Regeln für ein Abonnement verwendet wird.

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

Parameter

topicName

string

das Thema zum Erstellen ServiceBusRuleManager-

subscriptionName

string

das Abonnement, das für das angegebene Thema spezifisch ist, um eine ServiceBusRuleManager- zu erstellen.

Gibt zurück

ServiceBusRuleManager

ein ServiceBusRuleManager auf das angegebene Abonnement und Thema festgelegt ist.

createSender(string, ServiceBusSenderOptions)

Erstellt einen Absender, der verwendet werden kann, um Nachrichten zu senden, nachrichten zu einem späteren Zeitpunkt zu senden und solche geplanten Nachrichten abzubrechen. Es wird keine Verbindung mit dem Dienst hergestellt, bis eine der Methoden für den Absender aufgerufen wird.

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

Parameter

queueOrTopicName

string

Der Name einer Warteschlange oder eines Themas, an die Nachrichten gesendet werden sollen.

options

ServiceBusSenderOptions

Gibt zurück

ServiceBusSender