@azure/service-bus package

Klassen

MessagingError	Beschrijft de basisklasse voor Berichtfout.
ServiceBusAdministrationClient	Alle bewerkingen retourneren beloften die worden omgezet in een object met de relevante uitvoer. Deze objecten hebben ook een eigenschap met de naam _response die u kunt gebruiken als u toegang wilt krijgen tot het directe antwoord van de service.
ServiceBusClient	Een client die afzenderexemplaren kan maken voor het verzenden van berichten naar wachtrijen en onderwerpen, evenals ontvangersexemplaren om berichten van wachtrijen en abonnementen te ontvangen.
ServiceBusError	Fouten die optreden in Service Bus.

Interfaces

AuthorizationRule	Vertegenwoordigt het type van AuthorizationRule op ATOM gebaseerde beheerbewerkingen.
CorrelationRuleFilter	Vertegenwoordigt de expressie van het correlatiefilter. Een CorrelationRuleFilter bevat een set voorwaarden die worden vergeleken met gebruikers- en systeemeigenschappen van binnenkomende berichten van een abonnement.
CreateMessageBatchOptions	Opties voor het configureren van de createBatch methode op de Sender. maxSizeInBytes: De bovengrens voor de grootte van de batch. Gebruiksvoorbeeld: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Vertegenwoordigt instelbare opties in een wachtrij
CreateSubscriptionOptions	Vertegenwoordigt instelbare opties voor een abonnement
CreateTopicOptions	Vertegenwoordigt instelbare opties voor een onderwerp
DeadLetterOptions	Beschrijft de reden en foutbeschrijving voor het in de wachtrij zetten van een bericht met behulp van de deadLetter() methode voor het bericht dat is ontvangen van Service Bus.
Delivery
GetMessageIteratorOptions	Opties bij het ophalen van een iterator uit Service Bus.
HttpHeader	Een afzonderlijke header binnen een HttpHeaders-verzameling.
HttpHeadersLike	Een verzameling http-headersleutel-waardeparen.
HttpResponse	De eigenschappen van een HTTP-antwoord die altijd aanwezig zijn.
MessageHandlers	De interface van de algemene berichthandler (gebruikt voor streamMessages).
NamespaceProperties	Vertegenwoordigt de metagegevens met betrekking tot een Service Bus-naamruimte.
OperationOptions	Het type basisopties voor alle bewerkingen.
PeekMessagesOptions	Beschrijft de opties die worden doorgegeven aan de peekMessages methode op een ontvanger.
ProcessErrorArgs	Argumenten voor de processError callback.
QueueProperties	Vertegenwoordigt de invoer voor updateQueue.
QueueRuntimeProperties	Vertegenwoordigt runtimegegevenskenmerken van een wachtrijentiteit
ReceiveMessagesOptions	Opties bij het ontvangen van een batch berichten van Service Bus.
RetryOptions	Beleidsopties voor opnieuw proberen die de modus, het aantal nieuwe pogingen, het interval voor opnieuw proberen, enzovoort bepalen.
RuleProperties	Vertegenwoordigt alle kenmerken van een regel.
ServiceBusAdministrationClientOptions	Vertegenwoordigt de clientopties van de ServiceBusAdministrationClient.
ServiceBusClientOptions	Hierin worden de opties beschreven die kunnen worden opgegeven tijdens het maken van de ServiceBusClient. webSocketOptions : Opties voor het configureren van de channeling van de AMQP-verbinding via Web Sockets. websocket : De WebSocket-constructor die wordt gebruikt om een AMQP-verbinding te maken als u ervoor kiest om de verbinding via een WebSocket te maken. webSocketConstructorOptions : Opties om door te geven aan de Websocket-constructor wanneer u ervoor kiest om verbinding te maken via een WebSocket. retryOptions : de opties voor opnieuw proberen voor alle bewerkingen op de client. maxRetries : het aantal keren dat de bewerking opnieuw kan worden uitgevoerd in het geval van een fout die opnieuw kan worden geprobeerd. maxRetryDelayInMs: de maximale vertraging tussen nieuwe pogingen. Alleen van toepassing bij het uitvoeren van exponentiële nieuwe pogingen. mode: welke modus voor opnieuw proberen moet worden toegepast, opgegeven door de RetryMode enum. Opties zijn Exponential en Fixed. De standaardwaarde is Fixed. retryDelayInMs: de hoeveelheid tijd die moet worden gewacht in milliseconden voordat u de volgende poging uitvoert. Wanneer mode is ingesteld op Exponential, wordt dit gebruikt om de exponentieel toenemende vertragingen tussen nieuwe pogingen te berekenen. Standaard: 30000 milliseconden. timeoutInMs: De hoeveelheid tijd in milliseconden om te wachten voordat er een time-out optreedt voor de bewerking. Hierdoor wordt een nieuwe poging geactiveerd als er nog nieuwe pogingen zijn. Minimumwaarde: 60000 milliseconden.
ServiceBusConnectionStringProperties	De set eigenschappen waaruit een Service Bus-connection string bestaat.
ServiceBusMessage	Beschrijft het bericht dat naar Service Bus moet worden verzonden.
ServiceBusMessageBatch	Een batch berichten die u kunt maken met behulp van de <xref:createBatch> -methode.
ServiceBusReceivedMessage	Hierin wordt het bericht beschreven dat van Service Bus is ontvangen tijdens de korte weergavebewerkingen en dus niet kan worden vereffend.
ServiceBusReceiver	Een ontvanger die geen sessies afhandelt.
ServiceBusReceiverOptions	Opties om te gebruiken bij het maken van een ontvanger.
ServiceBusRuleManager	Hiermee kunnen regels voor een abonnement worden beheerd. Voor deze regelbeheerder zijn alleen Listen-claims vereist, terwijl voor ServiceBusAdministrationClient Claims beheren is vereist.
ServiceBusSender	Een afzender kan worden gebruikt om berichten te verzenden, berichten te plannen die op een later tijdstip worden verzonden en dergelijke geplande berichten te annuleren. Gebruik de createSender functie op de ServiceBusClient om een afzender te instantiëren. De klasse Afzender is een abstractie via de onderliggende AMQP-afzenderkoppeling.
ServiceBusSenderOptions	Opties die u kunt gebruiken bij het maken van een afzender.
ServiceBusSessionReceiver	Een ontvanger die sessies afhandelt, inclusief het vernieuwen van de sessievergrendeling.
ServiceBusSessionReceiverOptions	Hierin worden de opties beschreven die worden doorgegeven aan de acceptSession methoden en acceptNextSession wanneer u een wachtrij/abonnement gebruikt waarvoor sessies zijn ingeschakeld.
SqlRuleFilter	Vertegenwoordigt alle mogelijke velden op SqlRuleFilter
SubscribeOptions	Opties die worden gebruikt bij het abonneren op een Service Bus-wachtrij of -abonnement.
SubscriptionProperties	Vertegenwoordigt de invoer voor updateSubscription.
SubscriptionRuntimeProperties	Vertegenwoordigt runtimegegevenskenmerken van een abonnementsentiteit
TokenCredential	Vertegenwoordigt een referentie die een verificatietoken kan leveren.
TopicProperties	Vertegenwoordigt de invoer voor updateTopic.
TopicRuntimeProperties	Vertegenwoordigt runtimegegevenskenmerken van een onderwerpentiteit
TryAddOptions	De set opties voor het handmatig doorgeven van context voor gedistribueerde Span tracering.
WebResourceLike	Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij een externe server.
WebSocketImpl	Beschrijft de vereiste vorm van WebSocket-constructors.
WebSocketOptions	Opties voor het configureren van de channeling van de AMQP-verbinding via websockets.

Type-aliassen

EntitiesResponse	Vertegenwoordigt het resultaat van een lijstbewerking op entiteiten die ook de continuationToken bevat om te beginnen met herhalen vanaf.
EntityAvailabilityStatus	Mogelijke waarden voor availabilityStatus van de Service Bus-berichtenentiteiten.
EntityStatus	Mogelijke waarden voor status van de Service Bus-berichtenentiteiten.
OperationOptionsBase	OPMERKING: Dit type is bedoeld om de relevante velden en structuur van @azure/core-client OperationOptions te spiegelen Opties voor het configureren van tracering en de abortSignal.
RawHttpHeaders	Een HttpHeaders-verzameling die wordt weergegeven als een eenvoudig JSON-object.
ServiceBusErrorCode	Service Bus-foutcodes.
SqlRuleAction	Vertegenwoordigt alle mogelijke velden in SqlRuleAction
TransferProgressEvent	Geactiveerd als reactie op de voortgang van uploaden of downloaden.
WithResponse	Vertegenwoordigt het geretourneerde antwoord van de bewerking, samen met het onbewerkte antwoord.

Enums

RetryMode	Beschrijft het type Modus voor opnieuw proberen
TokenType	Beschrijft het type ondersteunde tokens.

Functies

delay<T>(number, AbortSignalLike, string, T)	Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.
isServiceBusError(unknown)	Bepaalt of een fout van het type is ServiceBusError
parseServiceBusConnectionString(string)	Parseert gegeven connection string in de verschillende eigenschappen die van toepassing zijn op Azure Service Bus. De eigenschappen zijn handig om vervolgens een ServiceBusClient te maken.

Functiedetails

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

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

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

Parameters

delayInMs

number

Het aantal milliseconden dat moet worden vertraagd.

abortSignal

AbortSignalLike

De abortSignal die is gekoppeld aan de bevattende bewerking.

abortErrorMsg

string

Het foutbericht bij afbreken dat is gekoppeld aan de betreffende bewerking.

value

T

De waarde waarmee moet worden omgezet na een time-out van t milliseconden.

Retouren

Promise<T | void>

• Opgeloste belofte

isServiceBusError(unknown)

Bepaalt of een fout van het type is ServiceBusError

function isServiceBusError(err: unknown): err

Parameters

err

unknown

Een fout om te controleren of het van het type ServiceBusError is

Retouren

err

parseServiceBusConnectionString(string)

Parseert gegeven connection string in de verschillende eigenschappen die van toepassing zijn op Azure Service Bus. De eigenschappen zijn handig om vervolgens een ServiceBusClient te maken.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parameters

connectionString

string

De connection string gekoppeld aan het beleid voor gedeelde toegang dat is gemaakt voor de Service Bus-naamruimte, -wachtrij of -onderwerp.

Retouren

ServiceBusConnectionStringProperties