@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 |
ServiceBusClient |
Client in grado di creare istanze del mittente per l'invio di messaggi a code e argomenti, nonché istanze di Ricevitore per ricevere messaggi da code e sottoscrizioni. |
ServiceBusError |
Errori che si verificano all'interno del bus di servizio. |
Interfacce
AuthorizationRule |
Rappresenta il tipo di |
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 metodo
Esempio di utilizzo:
|
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 l'invio di messaggi non recapitabili a un messaggio utilizzando il metodo |
Delivery | |
GetMessageIteratorOptions |
Opzioni quando si ottiene 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 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 |
Vengono descritte le opzioni passate al metodo |
ProcessErrorArgs |
Argomenti per il 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 del |
ServiceBusClientOptions |
Vengono descritte le opzioni che è possibile specificare durante la creazione di ServiceBusClient.
|
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 metodo <xref:createBatch>. |
ServiceBusReceivedMessage |
Descrive il messaggio ricevuto dal bus di servizio durante le operazioni di visualizzazione e quindi non può essere stabilito. |
ServiceBusReceiver |
Ricevitore che non gestisce le sessioni. |
ServiceBusReceiverOptions |
Opzioni da usare per la creazione di un ricevitore. |
ServiceBusRuleManager |
Consente la gestione di regole per una sottoscrizione. Questo gestore regole richiede solo attestazioni di ascolto, mentre il ServiceBusAdministrationClient richiede Gestisci attestazioni. |
ServiceBusSender |
Un mittente può essere usato per inviare messaggi, pianificare l'invio di messaggi in un secondo momento e annullare tali messaggi pianificati.
Usare la funzione |
ServiceBusSenderOptions |
Opzioni da usare per la creazione di un mittente. |
ServiceBusSessionReceiver |
Ricevitore che gestisce le sessioni, incluso il rinnovo del blocco della sessione. |
ServiceBusSessionReceiverOptions |
Vengono descritte le opzioni passate ai metodi |
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 da propagare manualmente |
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 il |
EntityAvailabilityStatus |
Valori possibili per |
EntityStatus |
Valori possibili per |
OperationOptionsBase |
NOTA: questo tipo è progettato per eseguire il mirroring dei campi e della struttura pertinenti da Opzioni per configurare la traccia e abortSignal. |
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 allo stato di caricamento o 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, Abort |
Wrapper per setTimeout che risolve una promessa dopo t millisecondi. |
is |
Determina se un errore è di tipo |
parse |
Analizza la stringa di connessione specificata nelle diverse proprietà applicabili al bus di servizio di Azure. Le proprietà sono utili per costruire un Oggetto 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
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 al bus di servizio di Azure. Le proprietà sono utili per costruire un Oggetto 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.