ServiceBusClient class
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
Service |
Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern für den in der Verbindungszeichenfolge 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. |
Service |
Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern für den 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
fully |
Der vollqualifizierte Namespace der Service Bus-Instanz, für die dieser Client erstellt wird. Dies ähnelt wahrscheinlich .servicebus.windows.net. |
identifier | Der Name, der verwendet wird, um diesen ServiceBusClient zu identifizieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges generiert. |
Methoden
accept |
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".
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
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".
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
Erstellt einen Empfänger für eine sitzungsaktivierte Azure Service Bus Warteschlange. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
accept |
Erstellt einen Empfänger für eine Sitzung, die Azure Service Bus Abonnement aktiviert ist. Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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 mit dieser Instanz erstellt wurden. |
create |
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. Um Unterwarteschlangen wie die Warteschlange für unzustellbare Briefe oder die Warteschlange für unzustellbare Nachrichten zu verwenden, geben Sie in den Optionen an Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet. Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
create |
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. Um Unterwarteschlangen wie die Warteschlange für unzustellbare Briefe oder die Warteschlange für unzustellbare Nachrichten zu verwenden, geben Sie in den Optionen an Sie können zwischen zwei Empfangsmodi wählen: "peekLock" (Standard) und "receiveAndDelete".
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für das Abonnement festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet. Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen. Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
create |
Erstellt eine Instanz von ServiceBusRuleManager , die zum Verwalten der Regeln für ein Abonnement verwendet wird. |
create |
Erstellt einen Absender, der zum Senden von Nachrichten, zum Planen des Sendens von Nachrichten zu einem späteren Zeitpunkt und zum Abbrechen solcher geplanten Nachrichten verwendet werden kann. 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 für den in der Verbindungszeichenfolge 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(connectionString: string, options?: ServiceBusClientOptions)
Parameter
- connectionString
-
string
Eine Verbindungszeichenfolge für Azure Service Bus Namespace. HINWEIS: Diese Verbindungszeichenfolge kann einen EntityPath enthalten, der ignoriert wird.
- options
- ServiceBusClientOptions
Optionen für den Service Bus-Client.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)
Erstellt eine Instanz der ServiceBusClient-Klasse, die zum Erstellen von Absendern und Empfängern für den 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 servicebus.windows.net ähnelt.
- credential
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 das entsprechende Token abgerufen wird ["https://servicebus.azure.net//user_impersonation"]
.
Verwenden Sie die AzureNamedKeyCredential
von @azure/core-auth, wenn Sie eine SharedAccessKeyName
und SharedAccessKey
ohne Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem name
Feld und key
in AzureNamedKeyCredential
zugeordnet.
Verwenden Sie die AzureSASCredential
von @azure/core-auth, wenn Sie ein SharedAccessSignature
übergeben möchten, ohne eine Verbindungszeichenfolge zu verwenden. Dieses Feld wird in AzureSASCredential
zugeordnetsignature
.
- 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. Zum Beispiel:{ "maxRetries": 4 }
oder{ "maxRetries": 4, "retryDelayInMs": 30000 }
. -
webSocketOptions
: Konfiguriert die Kanalung der AMQP-Verbindung über Websockets.
Details zur Eigenschaft
fullyQualifiedNamespace
Der vollqualifizierte Namespace der Service Bus-Instanz, für die dieser Client erstellt wird. Dies ähnelt wahrscheinlich .servicebus.windows.net.
fullyQualifiedNamespace: string
Eigenschaftswert
string
identifier
Der Name, der verwendet wird, um diesen ServiceBusClient zu identifizieren. Wenn nicht angegeben oder leer, wird ein zufälliges eindeutiges 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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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 (standardmäßig peekLock), Optionen zum Erstellen eines 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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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 (standardmäßig peekLock), Optionen zum Erstellen eines 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 sitzungsaktivierte 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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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, aus der Nachrichten empfangen werden müssen
- options
- ServiceBusSessionReceiverOptions
Zu den Optionen gehören receiveMode (standardmäßig peekLock), Optionen zum Erstellen eines 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 eine Sitzung, die Azure Service Bus Abonnement aktiviert ist.
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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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, aus der Nachrichten empfangen werden müssen
- options
- ServiceBusSessionReceiverOptions
Zu den Optionen gehören receiveMode (standardmäßig peekLock), Optionen zum Erstellen eines 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 mit 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.
Um Unterwarteschlangen wie die Warteschlange für unzustellbare Briefe oder die Warteschlange für unzustellbare Nachrichten zu verwenden, geben Sie in den Optionen an subQueue
. Weitere Informationen zu Warteschlangen für unzustellbare Nachrichten 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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für die Warteschlange festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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, standardmäßig peekLock.
Gibt zurück
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.
Um Unterwarteschlangen wie die Warteschlange für unzustellbare Briefe oder die Warteschlange für unzustellbare Nachrichten zu verwenden, geben Sie in den Optionen an subQueue
. Weitere Informationen zu Warteschlangen für unzustellbare Nachrichten 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 Nachricht für die in der Warteschlange angegebene Dauer.
- Im receiveAndDelete-Modus werden Nachrichten aus Service Bus gelöscht, während sie empfangen werden.
Nachrichten, die nicht innerhalb der Sperrdauer abgerechnet werden, werden so oft wie die für das Abonnement festgelegte maximale Übermittlungsanzahl erneut zugestellt, und danach werden sie an eine separate Warteschlange für unzustellbare Nachrichten gesendet.
Sie können eine Nachricht löschen, indem Sie die Methoden completeMessage(), abandonMessage(), deferMessage() oder deadletterMessage() auf dem Empfänger aufrufen.
Weitere Informationen zur Funktionsweise von peekLock und Nachrichtenabrechnung finden Sie hier: 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, standardmäßig peekLock.
Gibt zurück
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 von ServiceBusRuleManager
- subscriptionName
-
string
das Abonnement, das für das angegebene Thema spezifisch ist, für das ein ServiceBusRuleManager erstellt werden soll.
Gibt zurück
ein ServiceBusRuleManager , der auf das angegebene Abonnement und das angegebene Thema ausgerichtet ist.
createSender(string, ServiceBusSenderOptions)
Erstellt einen Absender, der zum Senden von Nachrichten, zum Planen des Sendens von Nachrichten zu einem späteren Zeitpunkt und zum Abbrechen solcher geplanten Nachrichten verwendet werden kann. 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