@azure/service-bus package

Klassen

MessagingError	Beschreibt die Basisklasse für Messaging Error.
ServiceBusAdministrationClient	Alle Vorgänge geben Zusagen zurück, die in ein Objekt aufgelöst werden, das über die relevante Ausgabe verfügt. Diese Objekte verfügen auch über eine Eigenschaft namens _response , die Sie verwenden können, wenn Sie auf die direkte Antwort des Diensts zugreifen möchten.
ServiceBusClient	Ein Client, der Senderinstanzen zum Senden von Nachrichten an Warteschlangen und Themen sowie Empfängerinstanzen zum Empfangen von Nachrichten von Warteschlangen und Abonnements erstellen kann.
ServiceBusError	Fehler, die in Service Bus auftreten.

Schnittstellen

AuthorizationRule	Stellt den Typ von 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 von eingehenden Nachrichten aus einem Abonnement abgeglichen werden.
CreateMessageBatchOptions	Optionen zum Konfigurieren der createBatch -Methode für .Sender maxSizeInBytes: Die Obergrenze für die Größe des Batches. Beispielverwendung: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Stellt feststellbare Optionen für eine Warteschlange dar.
CreateSubscriptionOptions	Stellt festlegbare Optionen für ein Abonnement dar.
CreateTopicOptions	Stellt festlegbare Optionen für ein Thema dar.
DeadLetterOptions	Beschreibt die Ursache und die Fehlerbeschreibung für das Unzustellbare Schreiben einer Nachricht mithilfe der deadLetter() -Methode für die von Service Bus empfangene Nachricht.
Delivery
GetMessageIteratorOptions	Optionen beim Abrufen eines iterierbaren Iterators von Service Bus.
HttpHeader	Ein einzelner Header innerhalb einer HttpHeaders-Auflistung.
HttpHeadersLike	Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.
HttpResponse	Die Eigenschaften einer HTTP-Antwort, die immer vorhanden ist.
MessageHandlers	Die allgemeine Nachrichtenhandlerschnittstelle (wird für streamMessages verwendet).
NamespaceProperties	Stellt die Metadaten im Zusammenhang mit einem Service Bus-Namespace dar.
OperationOptions	Der Basisoptionentyp für alle Vorgänge.
PeekMessagesOptions	Beschreibt die Optionen, die an die peekMessages -Methode auf einem Empfänger übergeben werden.
ProcessErrorArgs	Argumente für den processError Rückruf.
QueueProperties	Stellt die Eingabe für updateQueue dar.
QueueRuntimeProperties	Stellt Laufzeitinformationsattribute einer Warteschlangenentität dar.
ReceiveMessagesOptions	Optionen beim Empfangen eines Nachrichtenbatches von Service Bus.
RetryOptions	Wiederholungsrichtlinienoptionen, die den Modus, die Anzahl der Wiederholungen, das Wiederholungsintervall usw. bestimmen.
RuleProperties	Stellt alle Attribute einer Regel dar.
ServiceBusAdministrationClientOptions	Stellt die Clientoptionen von dar ServiceBusAdministrationClient.
ServiceBusClientOptions	Beschreibt die Optionen, die beim Erstellen des ServiceBusClients bereitgestellt werden können. webSocketOptions : Optionen zum Konfigurieren des Channellings 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, die an den Websocket-Konstruktor übergeben werden sollen, wenn Sie die Verbindung über ein WebSocket herstellen möchten. retryOptions : Die Wiederholungsoptionen für alle Vorgänge auf dem Client. maxRetries : Gibt an, wie oft der Vorgang im Falle eines wiederholungsfähigen Fehlers wiederholt werden kann. maxRetryDelayInMs: Die maximale Verzögerung zwischen Wiederholungen. Gilt nur bei exponentiellen Wiederholungsversuchen. mode: Der anzuwendende Wiederholungsmodus, der durch die RetryMode Enumeration angegeben wird. Die Optionen sind Exponential und Fixed. Wird standardmäßig auf Fixed festgelegt. retryDelayInMs: Der Zeitraum, der in Millisekunden gewartet werden soll, 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. Standardwert: 30000 Millisekunden. timeoutInMs: Zeitdauer in Millisekunden, um zu warten, bis das Timeout des Vorgangs auftritt. Dadurch wird ein Wiederholungsversuch ausgelöst, wenn noch Wiederholungsversuche vorhanden sind. Mindestwert: 60000 Millisekunden.
ServiceBusConnectionStringProperties	Der Satz von Eigenschaften, aus denen eine Service Bus-Verbindungszeichenfolge besteht.
ServiceBusMessage	Beschreibt die Nachricht, die an Service Bus gesendet werden soll.
ServiceBusMessageBatch	Ein Batch von Nachrichten, den Sie mit der <xref:createBatch> -Methode erstellen können.
ServiceBusReceivedMessage	Beschreibt die Nachricht, die von Service Bus während Einsehen von Vorgängen empfangen wurde und daher nicht abgerechnet werden kann.
ServiceBusReceiver	Ein Empfänger, der keine Sitzungen verarbeitet.
ServiceBusReceiverOptions	Optionen, die beim Erstellen eines Empfängers verwendet werden sollen.
ServiceBusRuleManager	Ermöglicht die Verwaltung von Regeln für ein Abonnement. Für diesen Regel-Manager sind nur Listenansprüche erforderlich, während serviceBusAdministrationClient Ansprüche verwalten erfordert.
ServiceBusSender	Ein Absender kann verwendet werden, um Nachrichten zu senden, 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 Methoden und acceptNextSession übergeben werden, wenn eine Warteschlange/ein Abonnement verwendet wird, für das Sitzungen aktiviert sind.
SqlRuleFilter	Represents all possible fields on SqlRuleFilter
SubscribeOptions	Optionen, die beim Abonnieren einer Service Bus-Warteschlange oder eines Service Bus-Abonnements verwendet werden.
SubscriptionProperties	Stellt die Eingabe für updateSubscription dar.
SubscriptionRuntimeProperties	Stellt Laufzeitinformationsattribute einer Abonnemententität dar.
TokenCredential	Stellt anmeldeinformationen dar, die ein Authentifizierungstoken bereitstellen können.
TopicProperties	Stellt die Eingabe für updateTopic dar.
TopicRuntimeProperties	Stellt Laufzeitinformationsattribute einer Themenentität dar.
TryAddOptions	Der Satz von Optionen zum manuellen Verteilen des Kontexts für die verteilte Span Ablaufverfolgung.
WebResourceLike	Eine Beschreibung einer HTTP-Anforderung, die an einen Remoteserver gestellt werden soll.
WebSocketImpl	Beschreibt die erforderliche Form von WebSocket-Konstruktoren.
WebSocketOptions	Optionen zum Konfigurieren des Channellings der AMQP-Verbindung über Websockets.

Typaliase

EntitiesResponse	Stellt das Ergebnis des Listenvorgangs für Entitäten dar, der auch die enthält, von der aus mit dem continuationToken Durchlaufen begonnen werden soll.
EntityAvailabilityStatus	Mögliche Werte für availabilityStatus die Service Bus-Messagingentitäten.
EntityStatus	Mögliche Werte für status die Service Bus-Messagingentitäten.
OperationOptionsBase	HINWEIS: Dieser Typ soll die relevanten Felder und Die Struktur von @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	Service Bus-Fehlercodes.
SqlRuleAction	Represents all possible fields on SqlRuleAction
TransferProgressEvent	Wird als Reaktion auf den Upload- oder Downloadstatus ausgelöst.
WithResponse	Stellt die zurückgegebene Antwort des Vorgangs zusammen mit der unformatierten Antwort dar.

Enumerationen

RetryMode	Beschreibt den Wiederholungsmodustyp.
TokenType	Beschreibt den Typ der unterstützten Token.

Functions

delay<T>(number, AbortSignalLike, string, T)	Ein Wrapper für setTimeout, der eine Zusage nach Millisekunden auflöst.
isServiceBusError(unknown)	Bestimmt, ob ein Fehler vom Typ ist. 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 Millisekunden auflöst.

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

Parameter

delayInMs

number

Die Anzahl der Millisekunden, die verzögert werden sollen.

abortSignal

AbortSignalLike

Das abortSignal, das dem enthaltenden Vorgang zugeordnet ist.

abortErrorMsg

string

Die Abbruchfehlermeldung, die dem enthaltenden Vorgang zugeordnet ist.

value

T

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

Gibt zurück

Promise<T | void>

• Aufgelöste Zusage

isServiceBusError(unknown)

Bestimmt, ob ein Fehler vom Typ ist. ServiceBusError

function isServiceBusError(err: unknown): err

Parameter

err

unknown

Ein Fehler, bei dem überprüft werden soll, ob es sich um einen ServiceBusError-Typ handelt.

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 Shared Access-Richtlinie zugeordnet ist, die für den Service Bus-Namespace, die Warteschlange oder das Service Bus-Thema erstellt wurde.

Gibt zurück

ServiceBusConnectionStringProperties