@azure/service-bus package

Klasser

MessagingError	Beskriver basklassen för meddelandefel.
ServiceBusAdministrationClient	Alla åtgärder returnerar löften som matchar ett objekt som har relevanta utdata. Dessa objekt har också en egenskap som heter _response som du kan använda om du vill komma åt direktsvaret från tjänsten.
ServiceBusClient	En klient som kan skapa avsändarinstanser för att skicka meddelanden till köer och ämnen samt mottagarinstanser för att ta emot meddelanden från köer och prenumerationer.
ServiceBusError	Fel som inträffar i Service Bus.

Gränssnitt

AuthorizationRule	Representerar typen av AuthorizationRule i ATOM-baserade hanteringsåtgärder.
CorrelationRuleFilter	Representerar korrelationsfilteruttrycket. Ett CorrelationRuleFilter innehåller en uppsättning villkor som matchas mot användar- och systemegenskaper för inkommande meddelanden från en prenumeration.
CreateMessageBatchOptions	Alternativ för att konfigurera metoden createBatch på Sender. maxSizeInBytes: Den övre gränsen för batchstorleken. Exempel på användning: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Representerar alternativ som kan konfigureras i en kö
CreateSubscriptionOptions	Representerar alternativ som kan konfigureras för en prenumeration
CreateTopicOptions	Representerar alternativ som kan användas i ett ämne
DeadLetterOptions	Beskriver orsaks- och felbeskrivningen för obeställbara meddelanden med hjälp av metoden deadLetter() på meddelandet som tas emot från Service Bus.
Delivery
GetMessageIteratorOptions	Alternativ när du hämtar en itererbar iterator från Service Bus.
HttpHeader	En enskild rubrik i en HttpHeaders-samling.
HttpHeadersLike	En samling HTTP-huvudnyckel/värdepar.
HttpResponse	Egenskaperna för ett HTTP-svar som alltid kommer att finnas.
MessageHandlers	Det allmänna gränssnittet för meddelandehanteraren (används för streamMessages).
NamespaceProperties	Representerar metadata som är relaterade till ett Service Bus-namnområde.
OperationOptions	Basalternativtypen för alla åtgärder.
PeekMessagesOptions	Beskriver de alternativ som skickas till metoden peekMessages på en mottagare.
ProcessErrorArgs	Argument till processError återanrop.
QueueProperties	Representerar indata för updateQueue.
QueueRuntimeProperties	Representerar körningsinformationsattribut för en köentitet
ReceiveMessagesOptions	Alternativ när du tar emot en batch med meddelanden från Service Bus.
RetryOptions	Återförsök av principalternativ som avgör läget, antalet återförsök, återförsöksintervall osv.
RuleProperties	Representerar alla attribut för en regel.
ServiceBusAdministrationClientOptions	Representerar klientalternativen för ServiceBusAdministrationClient.
ServiceBusClientOptions	Beskriver de alternativ som kan anges när du skapar ServiceBusClient. webSocketOptions : Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets. websocket : WebSocket-konstruktorn som används för att skapa en AMQP-anslutning om du väljer att upprätta anslutningen via en WebSocket. webSocketConstructorOptions : Alternativ för att skicka till Websocket-konstruktorn när du väljer att upprätta anslutningen via en WebSocket. retryOptions : Återförsöksalternativen för alla åtgärder på klienten. maxRetries : Antalet gånger åtgärden kan utföras igen om ett nytt försök kan göras. maxRetryDelayInMs: Den maximala fördröjningen mellan återförsök. Gäller endast vid exponentiella återförsök. mode: Vilket återförsöksläge som ska tillämpas, som anges av RetryMode uppräkning. Alternativen är Exponential och Fixed. Standardvärdet är Fixed. retryDelayInMs: Hur lång tid det tar att vänta i millisekunder innan nästa försök görs. När mode är inställt på Exponentialanvänds detta för att beräkna exponentiellt ökande fördröjningar mellan återförsök. Standard: 30 000 millisekunder. timeoutInMs: Tid i millisekunder att vänta innan åtgärden överskrider tidsgränsen. Detta utlöser ett nytt försök om det finns några återförsök kvar. Minsta värde: 6 0000 millisekunder.
ServiceBusConnectionStringProperties	Den uppsättning egenskaper som utgör en Service Bus-anslutningssträng.
ServiceBusMessage	Beskriver meddelandet som ska skickas till Service Bus.
ServiceBusMessageBatch	En batch med meddelanden som du kan skapa med hjälp av metoden <xref:createBatch>.
ServiceBusReceivedMessage	Beskriver meddelandet som togs emot från Service Bus under granskningsåtgärder och kan därför inte lösas.
ServiceBusReceiver	En mottagare som inte hanterar sessioner.
ServiceBusReceiverOptions	Alternativ att använda när du skapar en mottagare.
ServiceBusRuleManager	Tillåter att regler för en prenumeration hanteras. Den här regelhanteraren kräver bara Lyssnar-anspråk, medan ServiceBusAdministrationClient kräver Hantera anspråk.
ServiceBusSender	En avsändare kan användas för att skicka meddelanden, schemalägga meddelanden som ska skickas vid ett senare tillfälle och avbryta sådana schemalagda meddelanden. Använd funktionen createSender på ServiceBusClient för att instansiera en avsändare. Klassen Sender är en abstraktion över den underliggande AMQP-avsändarlänken.
ServiceBusSenderOptions	Alternativ att använda när du skapar en avsändare.
ServiceBusSessionReceiver	En mottagare som hanterar sessioner, inklusive förnyelse av sessionslåset.
ServiceBusSessionReceiverOptions	Beskriver de alternativ som skickas till metoderna acceptSession och acceptNextSession när du använder en kö/prenumeration som har sessioner aktiverade.
SqlRuleFilter	Representerar alla möjliga fält i SqlRuleFilter
SubscribeOptions	Alternativ som används när du prenumererar på en Service Bus-kö eller prenumeration.
SubscriptionProperties	Representerar indata för updateSubscription.
SubscriptionRuntimeProperties	Representerar körningsinformationsattribut för en prenumerationsentitet
TokenCredential	Representerar en autentiseringsuppgift som kan tillhandahålla en autentiseringstoken.
TopicProperties	Representerar indata för updateTopic.
TopicRuntimeProperties	Representerar körningsinformationsattribut för en ämnesentitet
TryAddOptions	Uppsättningen med alternativ för att manuellt sprida Span kontext för distribuerad spårning.
WebResourceLike	En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.
WebSocketImpl	Beskriver den form som krävs för WebSocket-konstruktorer.
WebSocketOptions	Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets.

Typalias

EntitiesResponse	Representerar resultatet av liståtgärden på entiteter som också innehåller continuationToken att börja iterera över från.
EntityAvailabilityStatus	Möjliga värden för availabilityStatus av Service Bus-meddelandeentiteterna.
EntityStatus	Möjliga värden för status av Service Bus-meddelandeentiteterna.
OperationOptionsBase	Obs! Den här typen är avsedd att spegla relevanta fält och struktur från @azure/core-client OperationOptions Alternativ för att konfigurera spårning och abortSignal.
RawHttpHeaders	En HttpHeaders-samling som representeras som ett enkelt JSON-objekt.
ServiceBusErrorCode	Service Bus-felkoder.
SqlRuleAction	Representerar alla möjliga fält i SqlRuleAction
TransferProgressEvent	Utlöstes som svar på överförings- eller nedladdningsframsteg.
WithResponse	Representerar det returnerade svaret för åtgärden tillsammans med råsvaret.

Uppräkningar

RetryMode	Beskriver typ av återförsöksläge
TokenType	Beskriver typen av token som stöds.

Funktioner

delay<T>(number, AbortSignalLike, string, T)	En wrapper för setTimeout som löser ett löfte efter t millisekunder.
isServiceBusError(unknown)	Avgör om ett fel är av typen ServiceBusError
parseServiceBusConnectionString(string)	Parsar angiven anslutningssträng i de olika egenskaper som gäller för Azure Service Bus. Egenskaperna är användbara för att sedan skapa en ServiceBusClient.

Funktionsinformation

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

En wrapper för setTimeout som löser ett löfte efter t millisekunder.

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

Parametrar

delayInMs

number

Antalet millisekunder som ska fördröjas.

abortSignal

AbortSignalLike

AbortSignal som är associerad med innehållande åtgärd.

abortErrorMsg

string

Det avbrutna felmeddelandet som är associerat med en åtgärd som innehåller åtgärden.

value

T

Värdet som ska matchas med efter en timeout på t millisekunder.

Returer

Promise<T | void>

• Löst löfte

isServiceBusError(unknown)

Avgör om ett fel är av typen ServiceBusError

function isServiceBusError(err: unknown): err

Parametrar

err

unknown

Ett fel för att kontrollera om det är av typen ServiceBusError

Returer

err

parseServiceBusConnectionString(string)

Parsar angiven anslutningssträng i de olika egenskaper som gäller för Azure Service Bus. Egenskaperna är användbara för att sedan skapa en ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parametrar

connectionString

string

Anslutningssträngen som är associerad med principen för delad åtkomst som skapats för Service Bus-namnområdet, kön eller ämnet.

Returer

ServiceBusConnectionStringProperties