@azure/service-bus package

Classi

MessagingError	Descrive la classe di base per l'errore di messaggistica.
ServiceBusAdministrationClient	Tutte le operazioni restituiscono promesse che vengono risolte in un oggetto con l'output pertinente. Questi oggetti hanno anche una proprietà denominata _response che è possibile usare se si vuole accedere alla risposta diretta dal servizio.
ServiceBusClient	Client in grado di creare istanze del mittente per l'invio di messaggi a code e argomenti, nonché istanze del ricevitore per la ricezione di messaggi da code e sottoscrizioni.
ServiceBusError	Errori che si verificano all'interno del bus di servizio.

Interfacce

AuthorizationRule	Rappresenta il tipo di nelle operazioni di AuthorizationRule gestione basate su ATOM.
CorrelationRuleFilter	Rappresenta l'espressione di filtro di correlazione. CorrelationRuleFilter contiene un set di condizioni corrispondenti alle proprietà utente e di sistema dei messaggi in arrivo da una sottoscrizione.
CreateMessageBatchOptions	Opzioni per configurare il createBatch metodo in Sender. maxSizeInBytes: limite superiore per le dimensioni del batch. Esempio di utilizzo: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Rappresenta le opzioni impostabili in una coda
CreateSubscriptionOptions	Rappresenta le opzioni impostabili in una sottoscrizione
CreateTopicOptions	Rappresenta le opzioni impostabili in un argomento
DeadLetterOptions	Descrive il motivo e la descrizione dell'errore per il mancato recapito di un messaggio usando il metodo nel deadLetter() messaggio ricevuto dal bus di servizio.
Delivery
GetMessageIteratorOptions	Opzioni per ottenere un iteratore iteratore iterabile dal bus di servizio.
HttpHeader	Singola intestazione all'interno di un insieme HttpHeaders.
HttpHeadersLike	Raccolta di coppie chiave/valore di intestazione HTTP.
HttpResponse	Proprietà in una risposta HTTP che sarà sempre presente.
MessageHandlers	Interfaccia generale del gestore di messaggi (usata per streamMessages).
NamespaceProperties	Rappresenta i metadati correlati a uno spazio dei nomi del bus di servizio.
OperationOptions	Tipo di opzioni di base per tutte le operazioni.
PeekMessagesOptions	Descrive le opzioni passate al peekMessages metodo in un ricevitore.
ProcessErrorArgs	Argomenti per il processError callback.
QueueProperties	Rappresenta l'input per updateQueue.
QueueRuntimeProperties	Rappresenta gli attributi delle informazioni di runtime di un'entità coda
ReceiveMessagesOptions	Opzioni per la ricezione di un batch di messaggi dal bus di servizio.
RetryOptions	Opzioni dei criteri di ripetizione dei tentativi che determinano la modalità, il numero di tentativi, l'intervallo di ripetizione dei tentativi e così via.
RuleProperties	Rappresenta tutti gli attributi di una regola.
ServiceBusAdministrationClientOptions	Rappresenta le opzioni client di ServiceBusAdministrationClient.
ServiceBusClientOptions	Descrive le opzioni che è possibile specificare durante la creazione di ServiceBusClient. webSocketOptions : opzioni per configurare il canale della connessione AMQP tramite Web Socket. websocket : il costruttore WebSocket usato per creare una connessione AMQP se si sceglie di stabilire la connessione tramite Un WebSocket. webSocketConstructorOptions : opzioni da passare al costruttore Websocket quando si sceglie di stabilire la connessione tramite un WebSocket. retryOptions : opzioni di ripetizione dei tentativi per tutte le operazioni nel client. maxRetries : numero di tentativi di ripetizione dell'operazione in caso di errore riprovabile. maxRetryDelayInMs: ritardo massimo tra i tentativi. Applicabile solo quando si eseguono tentativi esponenziali. mode: modalità di ripetizione dei tentativi da applicare, specificata dall'enumerazione RetryMode . Le opzioni sono Exponential e Fixed. Il valore predefinito è Fixed. retryDelayInMs: quantità di tempo di attesa in millisecondi prima di eseguire il tentativo successivo. Quando mode è impostato su Exponential, viene usato per calcolare i ritardi in aumento esponenziale tra i tentativi. Valore predefinito: 30000 millisecondi. timeoutInMs: intervallo di tempo in millisecondi di attesa prima del timeout dell'operazione. Verrà attivato un nuovo tentativo se sono presenti tentativi rimanenti. Valore minimo: 60000 millisecondi.
ServiceBusConnectionStringProperties	Set di proprietà che costituiscono una stringa di connessione del bus di servizio.
ServiceBusMessage	Descrive il messaggio da inviare al bus di servizio.
ServiceBusMessageBatch	Un batch di messaggi che è possibile creare usando il <xref:createBatch> metodo .
ServiceBusReceivedMessage	Descrive il messaggio ricevuto dal bus di servizio durante le operazioni di visualizzazione e quindi non può essere risolto.
ServiceBusReceiver	Ricevitore che non gestisce le sessioni.
ServiceBusReceiverOptions	Opzioni da utilizzare per la creazione di un ricevitore.
ServiceBusRuleManager	Consente la gestione di regole per una sottoscrizione. Questo gestore regole richiede solo attestazioni listen, mentre ServiceBusAdministrationClient richiede La gestione delle attestazioni.
ServiceBusSender	Un mittente può essere usato per inviare messaggi, pianificare l'invio dei messaggi in un secondo momento e annullare tali messaggi pianificati. Usare la createSender funzione in ServiceBusClient per creare un'istanza di Sender. La classe Sender è un'astrazione sul collegamento del mittente AMQP sottostante.
ServiceBusSenderOptions	Opzioni da utilizzare per la creazione di un mittente.
ServiceBusSessionReceiver	Ricevitore che gestisce le sessioni, incluso il rinnovo del blocco di sessione.
ServiceBusSessionReceiverOptions	Vengono descritte le opzioni passate ai acceptSession metodi e acceptNextSession quando si usa una coda/sottoscrizione con sessioni abilitate.
SqlRuleFilter	Rappresenta tutti i campi possibili in SqlRuleFilter
SubscribeOptions	Opzioni utilizzate per la sottoscrizione a una coda o una sottoscrizione del bus di servizio.
SubscriptionProperties	Rappresenta l'input per updateSubscription.
SubscriptionRuntimeProperties	Rappresenta gli attributi delle informazioni di runtime di un'entità di sottoscrizione
TokenCredential	Rappresenta una credenziale in grado di fornire un token di autenticazione.
TopicProperties	Rappresenta l'input per updateTopic.
TopicRuntimeProperties	Rappresenta gli attributi delle informazioni di runtime di un'entità argomento
TryAddOptions	Set di opzioni per propagare manualmente il Span contesto per la traccia distribuita.
WebResourceLike	Descrizione di una richiesta HTTP da effettuare a un server remoto.
WebSocketImpl	Descrive la forma richiesta dei costruttori WebSocket.
WebSocketOptions	Opzioni per configurare il canale della connessione AMQP tramite Web Socket.

Alias tipo

EntitiesResponse	Rappresenta il risultato dell'operazione di elenco sulle entità che contiene anche l'oggetto da cui avviare l'iterazione continuationToken .
EntityAvailabilityStatus	Valori possibili per availabilityStatus le entità di messaggistica del bus di servizio.
EntityStatus	Valori possibili per status le entità di messaggistica del bus di servizio.
OperationOptionsBase	NOTA: questo tipo è progettato per eseguire il mirroring dei campi e della struttura pertinenti da @azure/core-client OperationOptions Opzioni per la configurazione della traccia e l'interruzioneSignal.
RawHttpHeaders	Insieme HttpHeaders rappresentato come un semplice oggetto JSON.
ServiceBusErrorCode	Codici di errore del bus di servizio.
SqlRuleAction	Rappresenta tutti i campi possibili in SqlRuleAction
TransferProgressEvent	Generato in risposta all'avanzamento del caricamento o del download.
WithResponse	Rappresenta la risposta restituita dell'operazione insieme alla risposta non elaborata.

Enumerazioni

RetryMode	Descrive il tipo di modalità di ripetizione dei tentativi
TokenType	Descrive il tipo di token supportati.

Funzioni

delay<T>(number, AbortSignalLike, string, T)	Wrapper per setTimeout che risolve una promessa dopo t millisecondi.
isServiceBusError(unknown)	Determina se un errore è di tipo ServiceBusError
parseServiceBusConnectionString(string)	Analizza la stringa di connessione specificata nelle diverse proprietà applicabili a bus di servizio di Azure. Le proprietà sono utili per creare quindi un ServiceBusClient.

Dettagli funzione

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

Wrapper per setTimeout che risolve una promessa dopo t millisecondi.

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

Parametri

delayInMs

number

Numero di millisecondi da ritardare.

abortSignal

AbortSignalLike

Oggetto abortSignal associato all'operazione contenitore.

abortErrorMsg

string

Messaggio di errore di interruzione associato all'operazione contenitore.

value

T

Valore da risolvere con dopo un timeout di t millisecondi.

Restituisce

Promise<T | void>

• Promessa risolta

isServiceBusError(unknown)

Determina se un errore è di tipo ServiceBusError

function isServiceBusError(err: unknown): err

Parametri

err

unknown

Errore per verificare se è di tipo ServiceBusError

Restituisce

err

parseServiceBusConnectionString(string)

Analizza la stringa di connessione specificata nelle diverse proprietà applicabili a bus di servizio di Azure. Le proprietà sono utili per creare quindi un ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parametri

connectionString

string

Stringa di connessione associata ai criteri di accesso condiviso creati per lo spazio dei nomi, la coda o l'argomento del bus di servizio.

Restituisce

ServiceBusConnectionStringProperties