@azure/service-bus package

Osztályok

MessagingError	Az üzenetkezelési hiba alaposztályát ismerteti.
ServiceBusAdministrationClient	Minden művelet olyan ígéreteket ad vissza, amelyek a megfelelő kimenettel rendelkező objektumra lesznek feloldva. Ezeknek az objektumoknak is van egy _response nevű tulajdonsága, 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 üzenetsorokra és témakörökre, valamint fogadópéldányokra 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 AuthorizationRule típusát 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ő bejövő üzenetek felhasználói és rendszertulajdonságainak.
CreateMessageBatchOptions	A createBatchSender metódusának konfigurálására vonatkozó beállítások. maxSizeInBytes: A köteg méretének felső korlátja. Példahasználat: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Az üzenetsor beállítási beállításait jelöli
CreateSubscriptionOptions	Az előfizetés beállítási beállításait jelöli
CreateTopicOptions	Egy témakör beállítási beállításainak megjelenítése
DeadLetterOptions	A Service Bustól kapott üzenet deadLetter() metódusával ismerteti az üzenetek nem használt levéllel való megjelölésének okát és hibaleírását.
Delivery
GetMessageIteratorOptions	Az 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ék párok gyűjteménye.
HttpResponse	A HTTP-válasz tulajdonságai, amelyek mindig jelen lesznek.
MessageHandlers	Az általános üzenetkezelő felület (streamMessages esetén használatos).
NamespaceProperties	A service bus-névtérhez kapcsolódó metaadatokat jelöli.
OperationOptions	Az alapbeállítások típusa az összes művelethez.
PeekMessagesOptions	A fogadó peekMessages metódusának átadott beállításokat ismerteti.
ProcessErrorArgs	A processError visszahívás argumentumai.
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öteg fogadásának lehetőségei.
RetryOptions	Próbálkozzon újra a házirend beállításaival, amelyek meghatározzák a módot, az újrapróbálkozási lehetőségek számát, az újrapróbálkozási időközt stb.
RuleProperties	Egy szabály összes attribútumát jelöli.
ServiceBusAdministrationClientOptions	A ServiceBusAdministrationClientügyfélbeállításait jelöli.
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ának beállításai. websocket: Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. webSocketConstructorOptions: A Websocket-konstruktornak átadandó beállítások, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni. retryOptions: Az ügyfél összes műveletének újrapróbálkozási beállításai. maxRetries: A művelet újrapróbálkozásának 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 esetén alkalmazható. mode: Melyik újrapróbálkozási módot kell alkalmazni a RetryMode enumerálás által megadott módon. A beállítások Exponential és Fixed. Alapértelmezés szerint Fixed. retryDelayInMs: A következő kísérlet végrehajtása előtt ezredmásodpercben várni kell. Ha modeExponentialértékre van á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ási műveletet indít el, ha még vannak újrapróbálkozási kísérletek. Minimális érték: 60000 ezredmásodperc.
ServiceBusConnectionStringProperties	A Service Bus kapcsolati sztringet alkotó tulajdonságok készlete.
ServiceBusMessage	A Service Busnak küldendő üzenetet ismerteti.
ServiceBusMessageBatch	Üzenetköteg, amelyet a <xref:createBatch> metódussal hozhat létre.
ServiceBusReceivedMessage	A Service Bustól a betekintő műveletek során kapott üzenetet ismerteti, ezért nem lehet rendezni.
ServiceBusReceiver	Olyan fogadó, amely nem kezeli a munkameneteket.
ServiceBusReceiverOptions	A fogadó létrehozásakor használható beállítások.
ServiceBusRuleManager	Lehetővé teszi az előfizetések felügyeletét. Ez a szabálykezelő csak figyelési jogcímeket igényel, míg a ServiceBusAdministrationClient jogcímek kezelését igényli.
ServiceBusSender	A feladóval üzeneteket küldhet, ütemezheti az üzenetek későbbi küldését, és megszakíthatja az ilyen ütemezett üzeneteket. A ServiceBusClient createSender függvényével példányosíthatja a feladót. A Sender osztály absztrakció a mögöttes AMQP-feladó hivatkozáson.
ServiceBusSenderOptions	A feladó létrehozásakor használandó beállítások.
ServiceBusSessionReceiver	A munkameneteket kezelő fogadó, beleértve a munkamenet-zárolás megújítását is.
ServiceBusSessionReceiverOptions	A acceptSession és acceptNextSession metódusnak átadott beállításokat ismerteti, ha engedélyezett munkameneteket tartalmazó üzenetsort/előfizetést használ.
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 futtatókörnyezeti információattribútumait jelöli
TokenCredential	Hitelesítési jogkivonat megadására alkalmas hitelesítő adatokat jelöl.
TopicProperties	Az updateTopic bemenetét jelöli.
TopicRuntimeProperties	Egy témakör entitás futásidejű információattribútumait jelöli
TryAddOptions	Az elosztott nyomkövetés Span környezetének manuális propagálására szolgáló beállítások készlete.
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	Az entitások listaműveletének eredményét jelöli, amely tartalmazza a continuationToken is, amelyből újrakezdheti az iterálást.
EntityAvailabilityStatus	A Service Bus üzenetkezelési entitások availabilityStatus lehetséges értékei.
EntityStatus	A Service Bus üzenetkezelési entitások status lehetséges értékei.
OperationOptionsBase	MEGJEGYZÉS: Ez a típus az OperationOptions @azure/core-client vonatkozó mezőinek és szerkezetének 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 ezredmásodperc után felold egy ígéretet.
isServiceBusError(unknown)	Meghatározza, hogy egy hiba ServiceBusError típusú-e
parseServiceBusConnectionString(string)	A megadott kapcsolati sztringet az Azure Service Busra vonatkozó különböző tulajdonságokba elemzi. 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 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 műveletet tartalmazó művelethez társított abortSignal.

abortErrorMsg

string

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

value

T

Ezredmásodperc időtúllépés után feloldandó érték.

Válaszok

Promise<T | void>

• Megoldott ígéret

isServiceBusError(unknown)

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

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 sztringet az Azure Service Busra vonatkozó különböző tulajdonságokba elemzi. 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