Delen via


@azure/service-bus package

Klassen

MessagingError

Beschrijft de basisklasse voor berichtfout.

ServiceBusAdministrationClient

Alle bewerkingen retourneren beloftes 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 AuthorizationRule in beheerbewerkingen op basis van ATOM.

CorrelationRuleFilter

Vertegenwoordigt de correlatiefilterexpressie. Een CorrelationRuleFilter bevat een set voorwaarden die overeenkomen met de gebruikers- en systeemeigenschappen van binnenkomende berichten van een abonnement.

CreateMessageBatchOptions

Opties voor het configureren van de methode createBatch op de Sender.

  • maxSizeInBytes: de bovengrens voor de grootte van de batch.

Voorbeeldgebruik:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
CreateQueueOptions

Vertegenwoordigt settabelopties in een wachtrij

CreateSubscriptionOptions

Vertegenwoordigt settabelopties voor een abonnement

CreateTopicOptions

Vertegenwoordigt settabelopties voor een onderwerp

DeadLetterOptions

Beschrijft de reden en foutbeschrijving voor het schrijven 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 iterable iterator van 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 algemene berichthandlerinterface (gebruikt voor streamMessages).

NamespaceProperties

Vertegenwoordigt de metagegevens die betrekking hebben op een Service Bus-naamruimte.

OperationOptions

Het type basisopties voor alle bewerkingen.

PeekMessagesOptions

Beschrijft de opties die worden doorgegeven aan de methode peekMessages op een ontvanger.

ProcessErrorArgs

Argumenten voor de processError callback.

QueueProperties

Vertegenwoordigt de invoer voor updateQueue.

QueueRuntimeProperties

Vertegenwoordigt runtime-infokenmerken 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

Beschrijft de opties die kunnen worden opgegeven tijdens het maken van de ServiceBusClient.

  • webSocketOptions: opties voor het configureren van de kanaalling 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 verbinding te maken via een WebSocket.
    • 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 wanneer exponentieel nieuwe pogingen worden uitgevoerd.
    • mode: welke modus voor opnieuw proberen moet worden toegepast, opgegeven door de RetryMode enum. Opties zijn Exponential en Fixed. Standaard ingesteld op Fixed.
    • retryDelayInMs: De hoeveelheid tijd die moet worden gewacht in milliseconden voordat u de volgende poging probeert uit te voeren. 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 die moet worden gewacht voordat er een time-out optreedt voor de bewerking. Hiermee wordt een nieuwe poging geactiveerd als er nog nieuwe pogingen zijn. Minimumwaarde: 60000 milliseconden.
ServiceBusConnectionStringProperties

De set eigenschappen die een Service Bus-verbindingsreeks vormen.

ServiceBusMessage

Beschrijft het bericht dat moet worden verzonden naar Service Bus.

ServiceBusMessageBatch

Een batch berichten die u kunt maken met behulp van de methode <xref:createBatch>.

ServiceBusReceivedMessage

Beschrijft het bericht dat is ontvangen van Service Bus tijdens het bekijken van bewerkingen en kan dus niet worden vereffend.

ServiceBusReceiver

Een ontvanger die geen sessies verwerkt.

ServiceBusReceiverOptions

Opties die u kunt gebruiken bij het maken van een ontvanger.

ServiceBusRuleManager

Hiermee kunnen regels worden beheerd voor een abonnement. Voor deze regelbeheer zijn alleen listen-claims vereist, terwijl de ServiceBusAdministrationClient claims beheren vereist.

ServiceBusSender

Een afzender kan worden gebruikt om berichten te verzenden, berichten op een later tijdstip te plannen en dergelijke geplande berichten te annuleren. Gebruik de functie createSender 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 verwerkt, waaronder het vernieuwen van de sessievergrendeling.

ServiceBusSessionReceiverOptions

Beschrijft de opties die worden doorgegeven aan de acceptSession- en acceptNextSession-methoden bij het gebruik van een wachtrij/abonnement waarvoor sessies zijn ingeschakeld.

SqlRuleFilter

Vertegenwoordigt alle mogelijke velden in 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 runtime-infokenmerken van een onderwerpentiteit

TryAddOptions

De set opties voor het handmatig doorgeven van Span context voor gedistribueerde tracering.

WebResourceLike

Een beschrijving van een HTTP-aanvraag die moet worden gedaan op een externe server.

WebSocketImpl

Beschrijft de vereiste vorm van WebSocket-constructors.

WebSocketOptions

Opties voor het configureren van de kanaalling van de AMQP-verbinding via Web Sockets.

Type-aliassen

EntitiesResponse

Vertegenwoordigt het resultaat van de lijstbewerking op entiteiten die ook de continuationToken bevat om opnieuw te beginnen met herhalen.

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 het uploaden of downloaden van de voortgang.

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 ServiceBusError

parseServiceBusConnectionString(string)

Parseert de gegeven verbindingsreeks 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 bewerking die het bevat.

abortErrorMsg

string

Het afgebroken foutbericht dat is gekoppeld aan de bewerking die is gekoppeld aan de 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 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 de gegeven verbindingsreeks 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 verbindingsreeks die is gekoppeld aan het gedeelde toegangsbeleid dat is gemaakt voor de Service Bus-naamruimte, wachtrij of onderwerp.

Retouren