@azure/service-bus package

Osztályok

MessagingError	Az üzenetküldési hiba alaposztályát ismerteti.
ServiceBusAdministrationClient	Minden művelet olyan ígéreteket ad vissza, amelyek a megfelelő kimenettel rendelkező objektumra vannak feloldva. Ezeknek az objektumoknak van egy nevű tulajdonsága _response is, amelyet akkor használhat, ha hozzá szeretne férni a szolgáltatásból érkező közvetlen válaszhoz.
ServiceBusClient	Olyan ügyfél, amely képes feladópéldányokat létrehozni az üzenetek üzenetsorokra és témakörökbe való küldéséhez, valamint fogadópéldányokat az üzenetsorokból és előfizetésekből érkező üzenetek fogadásához.
ServiceBusError	A Service Busban előforduló hibák.

Interfészek

AuthorizationRule	Az ATOM-alapú felügyeleti műveletek típusát AuthorizationRule jelöli.
CorrelationRuleFilter	A korrelációs szűrőkifejezést jelöli. A CorrelationRuleFilter olyan feltételeket tartalmaz, amelyek megfelelnek az előfizetésből érkező üzenetek felhasználói és rendszertulajdonságainak.
CreateMessageBatchOptions	A metódus konfigurálásának createBatch beállításai a Senderkövetkezőn: . maxSizeInBytes: A köteg méretének felső korlátja. Példahasználat: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	A várólistán beállított beállításokat jelöli
CreateSubscriptionOptions	Az előfizetések beállítási beállításait jelöli
CreateTopicOptions	Témakör beállítási beállításait jelöli
DeadLetterOptions	A Service Bustól kapott üzenet metódusát használva deadLetter() ismerteti az üzenet kézbesítetlen leveleinek okát és hibaleírását.
Delivery
GetMessageIteratorOptions	Iterálási iterátor Service Busból való lekérésének lehetőségei.
HttpHeader	Egyéni fejléc egy HttpHeaders-gyűjteményben.
HttpHeadersLike	HTTP-fejléckulcs-/értékpárok gyűjteménye.
HttpResponse	A HTTP-válasz tulajdonságai, amelyek mindig jelen lesznek.
MessageHandlers	Az általános üzenetkezelő felület (a streamMessageshez használatos).
NamespaceProperties	A Service Bus-névtérhez kapcsolódó metaadatokat jelöli.
OperationOptions	Az összes művelet alapbeállítási típusa.
PeekMessagesOptions	A metódusnak átadott lehetőségeket ismerteti a peekMessages fogadón.
ProcessErrorArgs	A visszahívás argumentumai processError .
QueueProperties	Az updateQueue bemenetét jelöli.
QueueRuntimeProperties	Egy üzenetsor-entitás futásidejű információattribútumait jelöli
ReceiveMessagesOptions	A Service Bustól érkező üzenetkötegek fogadásának beállításai.
RetryOptions	Újrapróbálkozási szabályzatbeállítások, amelyek meghatározzák a módot, az újrapróbálkozások számát, az újrapróbálkozási időközt stb.
RuleProperties	Egy szabály összes attribútumát jelöli.
ServiceBusAdministrationClientOptions	A ügyfélbeállításokat jelöli.ServiceBusAdministrationClient
ServiceBusClientOptions	A ServiceBusClient létrehozásakor megadható beállításokat ismerteti. webSocketOptions : Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálására szolgáló beállítások. websocket : Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha a websocketen keresztüli kapcsolatot választja. webSocketConstructorOptions : A Websocket-konstruktornak átadandó beállítások, amikor a websocketen keresztüli kapcsolatot választja. retryOptions : Az ügyfél összes műveletének újrapróbálkozási lehetőségei. maxRetries : A művelet újrapróbálkozási idejének száma újrapróbálkozási hiba esetén. maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások végrehajtásakor alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni az RetryMode enumerálás által meghatározott módon. A lehetőségek a következők: Exponential és Fixed. Az alapértelmezett érték: Fixed. retryDelayInMs: Ennyi időt kell várni ezredmásodpercben a következő kísérlet végrehajtása előtt. Ha mode a értékre Exponentialvan állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késés kiszámítására szolgál. Alapértelmezett: 30000 ezredmásodperc. timeoutInMs: Ennyi idő ezredmásodpercben, amíg a művelet túllépi az időkorlátot. Ez újrapróbálkozást vált ki, ha még vannak újrapróbálkozási kísérletek. Minimális érték: 60000 ezredmásodperc.
ServiceBusConnectionStringProperties	A Service Bus-kapcsolati sztring alkotó tulajdonságok halmaza.
ServiceBusMessage	A Service Busnak küldendő üzenetet ismerteti.
ServiceBusMessageBatch	A metódussal <xref:createBatch> létrehozható üzenetköteg.
ServiceBusReceivedMessage	A Betekintő műveletek során a Service Bustól kapott üzenetet ismerteti, ezért nem rendezhető.
ServiceBusReceiver	Olyan fogadó, amely nem kezeli a munkameneteket.
ServiceBusReceiverOptions	Fogadó létrehozásakor használható beállítások.
ServiceBusRuleManager	Lehetővé teszi az előfizetések felügyeletének szabályait. Ez a szabálykezelő csak figyelési jogcímeket igényel, míg a ServiceBusAdministrationClienthez jogcímek kezelése szükséges.
ServiceBusSender	A küldővel üzeneteket küldhet, későbbre ütemezheti az üzeneteket, és megszakíthatja az ilyen ütemezett üzeneteket. createSender A ServiceBusClient függvényével példányosíthat egy feladót. A Sender osztály egy absztrakció a mögöttes AMQP-feladó hivatkozása felett.
ServiceBusSenderOptions	A feladó létrehozásakor használandó beállítások.
ServiceBusSessionReceiver	Munkameneteket kezelő fogadó, beleértve a munkamenet-zárolás megújítását is.
ServiceBusSessionReceiverOptions	A és acceptNextSession a acceptSession metódusnak átadott beállításokat ismerteti, ha olyan üzenetsort/előfizetést használ, amelynél engedélyezve vannak a munkamenetek.
SqlRuleFilter	Az SqlRuleFilter összes lehetséges mezőjét jelöli
SubscribeOptions	Service Bus-üzenetsorra vagy előfizetésre való feliratkozáskor használt beállítások.
SubscriptionProperties	Az updateSubscription bemenetét jelöli.
SubscriptionRuntimeProperties	Egy előfizetési entitás futásidejű információattribútumait jelöli
TokenCredential	Hitelesítési jogkivonat megadására alkalmas hitelesítő adatot jelöl.
TopicProperties	Az updateTopic bemenetét jelöli.
TopicRuntimeProperties	Témakörentitás futásidejű információattribútumait jelöli
TryAddOptions	Az elosztott nyomkövetés környezetének manuális propagálására szolgáló beállítások készlete Span .
WebResourceLike	A távoli kiszolgálóra irányuló HTTP-kérés leírása.
WebSocketImpl	A WebSocket konstruktorok szükséges alakját ismerteti.
WebSocketOptions	Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.

Típusaliasok

EntitiesResponse	A listaművelet eredményét jelöli az olyan entitásokon, amelyek az iterálást is tartalmazzák continuationToken .
EntityAvailabilityStatus	A Service Bus üzenetkezelési entitásainak lehetséges értékei availabilityStatus .
EntityStatus	A Service Bus üzenetkezelési entitásainak lehetséges értékei status .
OperationOptionsBase	MEGJEGYZÉS: Ez a típus az OperationOptions megfelelő mezőinek és szerkezetének @azure/core-client tükrözésére szolgál A nyomkövetés és az abortSignal konfigurálásának lehetőségei.
RawHttpHeaders	Egyszerű JSON-objektumként ábrázolt HttpHeaders-gyűjtemény.
ServiceBusErrorCode	Service Bus-hibakódok.
SqlRuleAction	Az SqlRuleAction összes lehetséges mezőjét jelöli
TransferProgressEvent	A feltöltési vagy letöltési folyamatra válaszul aktiválódott.
WithResponse	A művelet visszaadott válaszát és a nyers választ jelöli.

Enumerációk

RetryMode	Az újrapróbálkozási mód típusát ismerteti
TokenType	A támogatott jogkivonatok típusát ismerteti.

Függvények

delay<T>(number, AbortSignalLike, string, T)	A setTimeout burkolója, amely t ezredmásodperc után felold egy ígéretet.
isServiceBusError(unknown)	Meghatározza, hogy egy hiba típusú-e ServiceBusError
parseServiceBusConnectionString(string)	A megadott kapcsolati sztring elemezi a Azure Service Bus alkalmazható különböző tulajdonságokat. A tulajdonságok hasznosak a ServiceBusClient létrehozásához.

Függvény adatai

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

A setTimeout burkolója, amely t ezredmásodperc után felold egy ígéretet.

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

Paraméterek

delayInMs

number

A késleltetni kívánt ezredmásodpercek száma.

abortSignal

AbortSignalLike

A tartalmú művelethez társított abortSignal.

abortErrorMsg

string

A műveletet tartalmazó művelettel társított megszakítási hibaüzenet.

value

T

A feloldandó érték t ezredmásodperc időkorlát után.

Válaszok

Promise<T | void>

• Megoldott ígéret

isServiceBusError(unknown)

Meghatározza, hogy egy hiba típusú-e ServiceBusError

function isServiceBusError(err: unknown): err

Paraméterek

err

unknown

Hiba annak ellenőrzéséhez, hogy ServiceBusError típusú-e

Válaszok

err

parseServiceBusConnectionString(string)

A megadott kapcsolati sztring elemezi a Azure Service Bus alkalmazható különböző tulajdonságokat. A tulajdonságok hasznosak a ServiceBusClient létrehozásához.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Paraméterek

connectionString

string

A Service Bus-névtérhez, üzenetsorhoz vagy témakörhöz létrehozott megosztott hozzáférési szabályzathoz társított kapcsolati sztring.

Válaszok

ServiceBusConnectionStringProperties