@azure/service-bus package

Klassen

MessagingError	Beschreibt die Basisklasse für Messaging-Fehler.
ServiceBusAdministrationClient	Alle Vorgänge geben Zusagen zurück, die in ein Objekt aufgelöst werden, das die entsprechende Ausgabe aufweist. Diese Objekte haben auch eine Eigenschaft namens _response, die Sie verwenden können, wenn Sie auf die direkte Antwort des Diensts zugreifen möchten.
ServiceBusClient	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.
ServiceBusError	Fehler, die in Service Bus auftreten.

Schnittstellen

AuthorizationRule	Stellt den Typ der AuthorizationRule in ATOM-basierten Verwaltungsvorgängen dar.
CorrelationRuleFilter	Stellt den Korrelationsfilterausdruck dar. Ein CorrelationRuleFilter enthält eine Reihe von Bedingungen, die mit Benutzer- und Systemeigenschaften eingehender Nachrichten aus einem Abonnement abgeglichen werden.
CreateMessageBatchOptions	Optionen zum Konfigurieren der createBatch-Methode für die Sender. maxSizeInBytes: Die obere Grenze für die Größe des Batches. Beispielverwendung: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Stellt festgelegte Optionen in einer Warteschlange dar.
CreateSubscriptionOptions	Stellt festgelegte Optionen für ein Abonnement dar.
CreateTopicOptions	Stellt festgelegte Optionen für ein Thema dar.
DeadLetterOptions	Beschreibt die Ursache und Fehlerbeschreibung für das Schreiben einer Nachricht mit der deadLetter() Methode für die nachricht, die von Service Bus empfangen wurde.
Delivery
GetMessageIteratorOptions	Optionen beim Abrufen eines iterierbaren Iterators von Service Bus.
HttpHeader	Ein einzelner Header in einer HttpHeaders-Auflistung.
HttpHeadersLike	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
HttpResponse	Die Eigenschaften für eine HTTP-Antwort, die immer vorhanden ist.
MessageHandlers	Die allgemeine Nachrichtenhandlerschnittstelle (für streamMessages verwendet).
NamespaceProperties	Stellt die Metadaten im Zusammenhang mit einem Dienstbusnamespace dar.
OperationOptions	Der Basisoptionentyp für alle Vorgänge.
PeekMessagesOptions	Beschreibt die Optionen, die an die peekMessages-Methode eines Empfängers übergeben werden.
ProcessErrorArgs	Argumente für den processError Rückruf.
QueueProperties	Stellt die Eingabe für updateQueue dar.
QueueRuntimeProperties	Stellt Laufzeitinformationenattribute einer Warteschlangenentität dar.
ReceiveMessagesOptions	Optionen beim Empfangen eines Batches von Nachrichten von Service Bus.
RetryOptions	Wiederholen Sie Richtlinienoptionen, die den Modus, die Anzahl der Wiederholungen, das Wiederholungsintervall usw. bestimmen.
RuleProperties	Stellt alle Attribute einer Regel dar.
ServiceBusAdministrationClientOptions	Stellt die Clientoptionen des ServiceBusAdministrationClientdar.
ServiceBusClientOptions	Beschreibt die Optionen, die beim Erstellen des ServiceBusClient bereitgestellt werden können. webSocketOptions: Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets. websocket: Der WebSocket-Konstruktor, der zum Erstellen einer AMQP-Verbindung verwendet wird, wenn Sie die Verbindung über ein WebSocket herstellen möchten. webSocketConstructorOptions: Optionen zum Übergeben an den Websocket-Konstruktor, wenn Sie die Verbindung über ein WebSocket herstellen möchten. retryOptions: Die Wiederholungsoptionen für alle Vorgänge auf dem Client. maxRetries: Die Anzahl der Wiederholungsversuche des Vorgangs im Falle eines wiederholungsfähigen Fehlers. maxRetryDelayInMs: Die maximale Verzögerung zwischen Wiederholungen. Gilt nur, wenn exponentielle Wiederholungen ausgeführt werden. mode: Welcher Wiederholungsmodus angewendet werden soll, angegeben durch die RetryMode Enumeration. Optionen sind Exponential und Fixed. Standardmäßig wird Fixed. retryDelayInMs: Zeitaufwand für die Wartezeit in Millisekunden, bevor der nächste Versuch unternommen wird. Wenn mode auf Exponentialfestgelegt ist, wird dies verwendet, um die exponentiell steigenden Verzögerungen zwischen Wiederholungen zu berechnen. Standard: 30000 Millisekunden. timeoutInMs: Zeit in Millisekunden, bis der Vorgang ausläuft. Dadurch wird ein Wiederholungsversuch ausgelöst, wenn wiederholungsversuche noch vorhanden sind. Mindestwert: 60000 Millisekunden.
ServiceBusConnectionStringProperties	Der Satz von Eigenschaften, die eine Service Bus-Verbindungszeichenfolge umfassen.
ServiceBusMessage	Beschreibt die Nachricht, die an Service Bus gesendet werden soll.
ServiceBusMessageBatch	Ein Batch von Nachrichten, die Sie mithilfe der <xref:createBatch>-Methode erstellen können.
ServiceBusReceivedMessage	Beschreibt die nachricht, die während der Vorschauvorgänge von Service Bus empfangen wurde und daher nicht abgerechnet werden kann.
ServiceBusReceiver	Ein Empfänger, der keine Sitzungen behandelt.
ServiceBusReceiverOptions	Optionen, die beim Erstellen eines Empfängers verwendet werden sollen.
ServiceBusRuleManager	Ermöglicht die Verwaltung von Regeln für ein Abonnement. Dieser Regel-Manager erfordert nur Listenansprüche, während für den ServiceBusAdministrationClient "Verwalten von Ansprüchen" erforderlich ist.
ServiceBusSender	Ein Absender kann verwendet werden, um Nachrichten zu senden, nachrichten zu einem späteren Zeitpunkt zu planen und solche geplanten Nachrichten abzubrechen. Verwenden Sie die createSender-Funktion im ServiceBusClient, um einen Absender zu instanziieren. Die Sender-Klasse ist eine Abstraktion über den zugrunde liegenden AMQP-Absenderlink.
ServiceBusSenderOptions	Optionen, die beim Erstellen eines Absenders verwendet werden sollen.
ServiceBusSessionReceiver	Ein Empfänger, der Sitzungen verarbeitet, einschließlich der Verlängerung der Sitzungssperre.
ServiceBusSessionReceiverOptions	Beschreibt die Optionen, die an die acceptSession und acceptNextSession Methoden übergeben werden, wenn sie eine Warteschlange/ein Abonnement verwenden, für die Sitzungen aktiviert sind.
SqlRuleFilter	Stellt alle möglichen Felder in SqlRuleFilter dar.
SubscribeOptions	Optionen, die beim Abonnieren einer ServiceBus-Warteschlange oder eines Abonnements verwendet werden.
SubscriptionProperties	Stellt die Eingabe für updateSubscription dar.
SubscriptionRuntimeProperties	Stellt Laufzeitinformationenattribute einer Abonnemententität dar.
TokenCredential	Stellt eine Anmeldeinformation dar, die ein Authentifizierungstoken bereitstellen kann.
TopicProperties	Stellt die Eingabe für updateTopic dar.
TopicRuntimeProperties	Stellt Laufzeitinformationenattribute einer Themenentität dar.
TryAddOptions	Die Gruppe von Optionen, die Span Kontext für verteilte Ablaufverfolgung manuell verteilt werden sollen.
WebResourceLike	Eine Beschreibung einer HTTP-Anforderung, die an einem Remoteserver gesendet werden soll.
WebSocketImpl	Beschreibt die erforderliche Form von WebSocket-Konstruktoren.
WebSocketOptions	Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.

Typaliase

EntitiesResponse	Stellt das Ergebnis des Listenvorgangs für Entitäten dar, die auch die continuationToken enthält, von denen die Iterierung beginnen soll.
EntityAvailabilityStatus	Mögliche Werte für availabilityStatus der Service Bus-Nachrichtenentitäten.
EntityStatus	Mögliche Werte für status der Service Bus-Nachrichtenentitäten.
OperationOptionsBase	HINWEIS: Dieser Typ soll die relevanten Felder und Strukturen aus @azure/core-client OperationOptions spiegeln. Optionen zum Konfigurieren der Ablaufverfolgung und des AbortSignals.
RawHttpHeaders	Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird.
ServiceBusErrorCode	Dienstbus-Fehlercodes.
SqlRuleAction	Stellt alle möglichen Felder in SqlRuleAction dar.
TransferProgressEvent	Wird als Reaktion auf den Upload- oder Downloadfortschritt ausgelöst.
WithResponse	Stellt die zurückgegebene Antwort des Vorgangs zusammen mit der unformatierten Antwort dar.

Enumerationen

RetryMode	Beschreibt den Typ "Wiederholungsmodus"
TokenType	Beschreibt den Typ der unterstützten Token.

Functions

delay<T>(number, AbortSignalLike, string, T)	Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.
isServiceBusError(unknown)	Bestimmt, ob ein Fehler vom Typ ServiceBusError
parseServiceBusConnectionString(string)	Analysiert die angegebene Verbindungszeichenfolge in die verschiedenen Eigenschaften, die für Azure Service Bus gelten. Die Eigenschaften sind nützlich, um dann einen ServiceBusClient zu erstellen.

Details zur Funktion

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

Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.

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

Parameter

delayInMs

number

Die Anzahl der zu verzögernden Millisekunden.

abortSignal

AbortSignalLike

The abortSignal associated with containing operation.

abortErrorMsg

string

Die abbruchfehlermeldung, die dem enthaltenden Vorgang zugeordnet ist.

value

T

Der Wert, der nach einem Timeout von t Millisekunden aufgelöst werden soll.

Gibt zurück

Promise<T | void>

• Gelöste Zusage

isServiceBusError(unknown)

Bestimmt, ob ein Fehler vom Typ ServiceBusError

function isServiceBusError(err: unknown): err

Parameter

err

unknown

Ein Fehler, um festzustellen, ob es vom Typ "ServiceBusError" ist

Gibt zurück

err

parseServiceBusConnectionString(string)

Analysiert die angegebene Verbindungszeichenfolge in die verschiedenen Eigenschaften, die für Azure Service Bus gelten. Die Eigenschaften sind nützlich, um dann einen ServiceBusClient zu erstellen.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parameter

connectionString

string

Die Verbindungszeichenfolge, die der Richtlinie für den freigegebenen Zugriff zugeordnet ist, die für den ServiceBus-Namespace, die Warteschlange oder das Thema erstellt wurde.

Gibt zurück

ServiceBusConnectionStringProperties