@azure/service-bus package

Třídy

MessagingError	Popisuje základní třídu chyby zasílání zpráv.
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 vytvořit 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 AuthorizationRule v operacích správy založených na atomech.
CorrelationRuleFilter	Představuje výraz filtru korelace. CorrelationRuleFilter obsahuje sadu podmínek, které se shodují s vlastnostmi uživatele a systému příchozích zpráv z odběru.
CreateMessageBatchOptions	Možnosti konfigurace metody createBatch na Sender. maxSizeInBytes: Horní limit velikosti dávky. Příklad použití: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Představuje nastavitelné možnosti ve frontě.
CreateSubscriptionOptions	Představuje nastavené možnosti v předplatném.
CreateTopicOptions	Představuje nastavitelné možnosti v tématu.
DeadLetterOptions	Popisuje důvod a popis chyby pro nedoručení zprávy pomocí metody deadLetter() na zprávě přijaté ze služby Service Bus.
Delivery
GetMessageIteratorOptions	Možnosti při získávání iterátoru z 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 přítomna.
MessageHandlers	Obecné rozhraní obslužné rutiny zprávy (používá se pro streamMessages).
NamespaceProperties	Představuje metadata související s oborem názvů služby Service Bus.
OperationOptions	Základní typ možností pro všechny operace.
PeekMessagesOptions	Popisuje možnosti předávané metodě peekMessages příjemce.
ProcessErrorArgs	Argumenty zpětného volání processError.
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 ServiceBusAdministrationClient.
ServiceBusClientOptions	Popisuje možnosti, které lze poskytnout při vytváření ServiceBusClient. webSocketOptions: Možnosti konfigurace kanálu 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í konstruktoru Websocket, když se rozhodnete vytvořit připojení přes WebSocket. retryOptions: Možnosti opakování pro všechny operace v klientovi. maxRetries: Počet opakování operace v případě chyby, která se dá opakovat. 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 je mode nastavená na Exponential, slouží k výpočtu exponenciálně rostoucích zpoždění mezi opakováními. Výchozí hodnota: 30000 milisekund. timeoutInMs: Doba čekání v milisekundách, než vyprší časový limit operace. Tím se aktivuje opakování, pokud zbyly nějaké pokusy o 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 do služby Service Bus.
ServiceBusMessageBatch	Dávku zpráv, které můžete vytvořit pomocí metody <xref:createBatch>.
ServiceBusReceivedMessage	Popisuje zprávu přijatou službou Service Bus během operací náhledu, a proto ji nelze vyřešit.
ServiceBusReceiver	Příjemce, který nezpracuje relace.
ServiceBusReceiverOptions	Možnosti, které se mají použít při vytváření příjemce
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ílatel lze použít k odesílání zpráv, naplánování odesílání zpráv později a zrušení takových naplánovaných zpráv. Pomocí funkce createSender na ServiceBusClient vytvořte instanci odesílatele. Třída Sender je abstrakce nad podkladovým odkazem odesílatele AMQP.
ServiceBusSenderOptions	Možnosti použití 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é acceptSession a acceptNextSession metodám při použití fronty nebo předplatného s povolenými relacemi.
SqlRuleFilter	Představuje všechna možná pole v 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 kanálu připojení AMQP přes webové sokety

Aliasy typu

EntitiesResponse	Představuje výsledek operace seznamu u entit, které obsahují také continuationToken, ze kterých se má začít iterovat.
EntityAvailabilityStatus	Možné hodnoty pro availabilityStatus entit zasílání zpráv služby Service Bus.
EntityStatus	Možné hodnoty pro status entit 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 chyb služby Service Bus
SqlRuleAction	Představuje všechna možná pole v SqlRuleAction.
TransferProgressEvent	Aktivovalo se 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 milisekundách.
isServiceBusError(unknown)	Určuje, jestli je chyba typu ServiceBusError
parseServiceBusConnectionString(string)	Parsuje 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 milisekundách.

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

Parametry

delayInMs

number

Počet milisekund, které mají být zpožděny.

abortSignal

AbortSignalLike

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

abortErrorMsg

string

Chybová zpráva o přerušení přidružené k operaci obsahující.

value

T

Hodnota, se kterou se má vyřeš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, jestli se jedná o typ ServiceBusError

Návraty

err

parseServiceBusConnectionString(string)

Parsuje 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