@azure/service-bus package

Třídy

MessagingError	Popisuje základní třídu pro zasílání zpráv Error.
ServiceBusAdministrationClient	Všechny operace vrací přísliby, které se přeloží na objekt, který má příslušný výstup. Tyto objekty mají také vlastnost s názvem _response , kterou můžete použít, pokud chcete získat přístup k přímé odpovědi ze služby.
ServiceBusClient	Klient, který může vytvářet instance odesílatele pro odesílání zpráv do front a témat a také instance příjemce pro příjem zpráv z front a odběrů.
ServiceBusError	Chyby, ke kterým dochází ve službě Service Bus.

Rozhraní

AuthorizationRule	Představuje typ v operacích AuthorizationRule správy založených na ATOM.
CorrelationRuleFilter	Představuje výraz filtru korelace. CorrelationRuleFilter obsahuje sadu podmínek, které odpovídají uživatelským a systémovým vlastnostem příchozích zpráv z odběru.
CreateMessageBatchOptions	Možnosti konfigurace metody na createBatch .Sender maxSizeInBytes: Horní limit pro velikost dávky. Příklad použití: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Představuje nastavené možnosti ve frontě.
CreateSubscriptionOptions	Představuje nastavitelné možnosti předplatného.
CreateTopicOptions	Představuje nastavené možnosti pro téma.
DeadLetterOptions	Popisuje důvod a popis chyby pro nedoručených zpráv pomocí deadLetter() metody pro zprávu přijatou ze služby Service Bus.
Delivery
GetMessageIteratorOptions	Možnosti při získávání iterovatelného iterátoru ze služby Service Bus
HttpHeader	Jednotlivá hlavička v kolekci HttpHeaders.
HttpHeadersLike	Kolekce párů klíč/hodnota hlavičky HTTP.
HttpResponse	Vlastnosti odpovědi HTTP, která bude vždy k dispozici.
MessageHandlers	Obecné rozhraní obslužné rutiny zpráv (používá se pro streamMessages).
NamespaceProperties	Představuje metadata související s oborem názvů služby Service Bus.
OperationOptions	Typ základních možností pro všechny operace.
PeekMessagesOptions	Popisuje možnosti předávané peekMessages metodě na přijímači.
ProcessErrorArgs	Argumenty zpětného processError volání.
QueueProperties	Představuje vstup pro updateQueue.
QueueRuntimeProperties	Představuje atributy informací o modulu runtime entity fronty.
ReceiveMessagesOptions	Možnosti při příjmu dávky zpráv ze služby Service Bus
RetryOptions	Možnosti zásad opakování, které určují režim, počet opakování, interval opakování atd.
RuleProperties	Představuje všechny atributy pravidla.
ServiceBusAdministrationClientOptions	Představuje možnosti klienta objektu ServiceBusAdministrationClient.
ServiceBusClientOptions	Popisuje možnosti, které lze poskytnout při vytváření ServiceBusClient. webSocketOptions : Možnosti konfigurace channelingu připojení AMQP přes webové sokety. websocket : Konstruktor WebSocket použitý k vytvoření připojení AMQP, pokud se rozhodnete vytvořit připojení přes WebSocket. webSocketConstructorOptions : Možnosti předání do websocket konstruktoru, když se rozhodnete vytvořit připojení přes WebSocket. retryOptions : Možnosti opakování pro všechny operace v klientovi. maxRetries : Kolikrát je možné operaci zopakovat v případě opakovatelné chyby. maxRetryDelayInMs: Maximální zpoždění mezi opakovanými pokusy. Platí pouze při provádění exponenciálních opakování. mode: Který režim opakování se má použít, určený výčtem RetryMode . Možnosti jsou Exponential a Fixed. Výchozí hodnota je Fixed. retryDelayInMs: Doba čekání v milisekundách před provedením dalšího pokusu. Pokud mode je nastavená hodnota Exponential, použije se k výpočtu exponenciálně rostoucích zpoždění mezi opakovanými pokusy. Výchozí hodnota: 30000 milisekund. timeoutInMs: Doba čekání v milisekundách před vypršením časového limitu operace. Pokud zbývají nějaké pokusy o opakování, aktivuje se tím opakování. Minimální hodnota: 60000 milisekund.
ServiceBusConnectionStringProperties	Sada vlastností, které tvoří připojovací řetězec služby Service Bus.
ServiceBusMessage	Popisuje zprávu, která se má odeslat službě Service Bus.
ServiceBusMessageBatch	Dávka zpráv, které můžete vytvořit pomocí <xref:createBatch> metody.
ServiceBusReceivedMessage	Popisuje zprávu přijatou ze služby Service Bus během operací náhledu, takže ji nelze vyřešit.
ServiceBusReceiver	Příjemce, který nezpracuje relace.
ServiceBusReceiverOptions	Možnosti, které se mají použít při vytváření přijímače.
ServiceBusRuleManager	Umožňuje spravovat pravidla pro předplatné. Tento správce pravidel vyžaduje pouze deklarace identity naslouchání, zatímco ServiceBusAdministrationClient vyžaduje spravovat deklarace identity.
ServiceBusSender	Odesílatele lze použít k odesílání zpráv, plánování odesílání zpráv později a zrušení takových naplánovaných zpráv. createSender Pomocí funkce na ServiceBusClient vytvořte instanci odesílatele. Třída Sender je abstrakce nad podkladovým odkazem odesílatele AMQP.
ServiceBusSenderOptions	Možnosti, které se mají použít při vytváření odesílatele.
ServiceBusSessionReceiver	Příjemce, který zpracovává relace, včetně obnovení zámku relace.
ServiceBusSessionReceiverOptions	Popisuje možnosti předávané metodám acceptSession a acceptNextSession při použití fronty nebo předplatného s povolenými relacemi.
SqlRuleFilter	Představuje všechna možná pole ve filtru SqlRuleFilter.
SubscribeOptions	Možnosti používané při přihlášení k odběru fronty nebo předplatného služby Service Bus
SubscriptionProperties	Představuje vstup pro updateSubscription.
SubscriptionRuntimeProperties	Představuje atributy informací o modulu runtime entity předplatného.
TokenCredential	Představuje přihlašovací údaje schopné poskytnout ověřovací token.
TopicProperties	Představuje vstup pro updateTopic.
TopicRuntimeProperties	Představuje atributy informací o modulu runtime entity tématu.
TryAddOptions	Sada možností pro ruční šíření Span kontextu pro distribuované trasování
WebResourceLike	Popis požadavku HTTP, který se má provést na vzdálený server.
WebSocketImpl	Popisuje požadovaný tvar konstruktorů WebSocket.
WebSocketOptions	Možnosti konfigurace channelingu připojení AMQP přes webové sokety

Aliasy typu

EntitiesResponse	Představuje výsledek operace seznamu u entit, která obsahuje continuationToken také operaci, ze které se má začít iterovat.
EntityAvailabilityStatus	Možné hodnoty entit availabilityStatus zasílání zpráv služby Service Bus.
EntityStatus	Možné hodnoty entit status zasílání zpráv služby Service Bus.
OperationOptionsBase	POZNÁMKA: Tento typ je určen k zrcadlení příslušných polí a struktury z @azure/core-client OperationOptions. Možnosti konfigurace trasování a abortSignal
RawHttpHeaders	Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.
ServiceBusErrorCode	Kódy selhání služby Service Bus.
SqlRuleAction	Představuje všechna možná pole v SqlRuleAction.
TransferProgressEvent	Aktivované v reakci na průběh nahrávání nebo stahování.
WithResponse	Představuje vrácenou odpověď operace spolu s nezpracovanou odpovědí.

Výčty

RetryMode	Popisuje typ režimu opakování.
TokenType	Popisuje typ podporovaných tokenů.

Funkce

delay<T>(number, AbortSignalLike, string, T)	Obálka pro setTimeout, která vyřeší příslib po t milisekundách.
isServiceBusError(unknown)	Určuje, jestli je chyba typu. ServiceBusError
parseServiceBusConnectionString(string)	Analyzuje zadaný připojovací řetězec do různých vlastností použitelných pro Azure Service Bus. Vlastnosti jsou užitečné k vytvoření ServiceBusClient.

Podrobnosti funkce

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

Obálka pro setTimeout, která vyřeší příslib po t milisekundách.

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

Parametry

delayInMs

number

Počet milisekund, které se mají zpozdit.

abortSignal

AbortSignalLike

AbortSignal přidružený k operaci obsahující.

abortErrorMsg

string

Chybová zpráva o přerušení související s operací obsahující.

value

T

Hodnota, se kterou se má přeložit po vypršení časového limitu t milisekund.

Návraty

Promise<T | void>

• Vyřešený slib

isServiceBusError(unknown)

Určuje, jestli je chyba typu. ServiceBusError

function isServiceBusError(err: unknown): err

Parametry

err

unknown

Chyba, která se má zkontrolovat a zjistit, jestli je typu ServiceBusError

Návraty

err

parseServiceBusConnectionString(string)

Analyzuje zadaný připojovací řetězec do různých vlastností použitelných pro Azure Service Bus. Vlastnosti jsou užitečné k vytvoření ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parametry

connectionString

string

Připojovací řetězec přidružený k zásadám sdíleného přístupu vytvořeným pro obor názvů, frontu nebo téma služby Service Bus.

Návraty

ServiceBusConnectionStringProperties