Condividi tramite

ServiceBusClient class

  • Riferimento
Pacchetto:
@azure/service-bus

Client che può creare istanze del mittente per l'invio di messaggi a code e argomenti, nonché istanze di Ricevitore per ricevere messaggi da code e sottoscrizioni.

Costruttori

ServiceBusClient(string, ServiceBusClientOptions)

Crea un'istanza della classe ServiceBusClient che può essere usata per creare mittenti e ricevitori nello spazio dei nomi bus di servizio di Azure fornito nella stringa di connessione. Nessuna connessione al servizio fino a quando i mittenti o i ricevitori creati con il client vengono usati per inviare/ricevere messaggi.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Crea un'istanza della classe ServiceBusClient che può essere usata per creare mittenti e ricevitori nello spazio dei nomi bus di servizio di Azure fornito. Nessuna connessione al servizio fino a quando i mittenti o i ricevitori creati con il client vengono usati per inviare/ricevere messaggi.

Proprietà

fullyQualifiedNamespace

Spazio dei nomi completo dell'istanza del bus di servizio per cui viene creato il client. È probabile che sia simile a .servicebus.windows.net.
identifier

Nome utilizzato per identificare questo ServiceBusClient. Se non specificato o vuoto, verrà generato un univoco casuale.

Metodi

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una coda di bus di servizio di Azure abilitata per la sessione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una sottoscrizione di bus di servizio di Azure abilitata per la sessione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una sessione abilitata bus di servizio di Azure coda.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una sessione abilitata bus di servizio di Azure sottoscrizione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Chiude la connessione AMQP sottostante. NOTA: questa operazione disconnetterà anche eventuali istanze di ricevitore o mittente create da questa istanza.
createReceiver(string, ServiceBusReceiverOptions)

Crea un ricevitore per una coda di bus di servizio di Azure. Nessuna connessione viene effettuata al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per indirizzare le sotto code, ad esempio la coda di lettere non recapitabili o la coda di messaggi non recapitabili, specificare le subQueue opzioni. Per altre informazioni sulle code di lettere non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

I messaggi che non vengono risolti all'interno della durata del blocco verranno ridistribuiti quante volte il numero massimo di recapito impostato nella coda, dopo il quale vengono inviati a una coda di messaggi non recapitabili separati.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)

Crea un ricevitore per una sottoscrizione bus di servizio di Azure. Nessuna connessione viene effettuata al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per indirizzare le sotto code, ad esempio la coda di lettere non recapitabili o la coda di messaggi non recapitabili, specificare le subQueue opzioni. Per altre informazioni sulle code di lettere non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

I messaggi che non vengono risolti entro la durata del blocco verranno ridistribuiti quante volte il numero massimo di recapito impostato nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separati.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)

Crea un'istanza di ServiceBusRuleManager usata per gestire le regole per una sottoscrizione.
createSender(string, ServiceBusSenderOptions)

Crea un mittente che può essere usato per inviare messaggi, pianificare l'invio di messaggi in un secondo momento e annullare tali messaggi pianificati. Nessuna connessione al servizio finché non viene chiamato uno dei metodi del mittente.

Dettagli costruttore

ServiceBusClient(string, ServiceBusClientOptions)

Crea un'istanza della classe ServiceBusClient che può essere usata per creare mittenti e ricevitori nello spazio dei nomi bus di servizio di Azure fornito nella stringa di connessione. Nessuna connessione al servizio fino a quando i mittenti o i ricevitori creati con il client vengono usati per inviare/ricevere messaggi.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Parametri

connectionString

string

Stringa di connessione per lo spazio dei nomi bus di servizio di Azure. NOTA: questa stringa di connessione può contenere un EntityPath, che viene ignorato.

options
ServiceBusClientOptions

Opzioni per il client del bus di servizio.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Crea un'istanza della classe ServiceBusClient che può essere usata per creare mittenti e ricevitori nello spazio dei nomi bus di servizio di Azure fornito. Nessuna connessione al servizio fino a quando i mittenti o i ricevitori creati con il client vengono usati per inviare/ricevere messaggi.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Parametri

fullyQualifiedNamespace

string

Spazio dei nomi completo dell'istanza del bus di servizio, probabilmente simile a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Oggetto credenziale usato dal client per ottenere il token per autenticare la connessione con il bus di servizio di Azure. Per la creazione delle credenziali, vedere @azure/identity. Se si usa una propria implementazione dell'interfaccia TokenCredential su AAD, impostare gli "ambiti" per il bus di servizio per ["https://servicebus.azure.net//user_impersonation"] ottenere il token appropriato. Usare l'oggetto AzureNamedKeyCredential da @azure/core-auth se si vuole passare un SharedAccessKeyName oggetto e SharedAccessKey senza usare una stringa di connessione. Questi campi vengono mappati rispettivamente al name campo e key in AzureNamedKeyCredential. Usare l'oggetto AzureSASCredential da @azure/core-auth se si vuole passare un SharedAccessSignature oggetto senza usare una stringa di connessione. Questo campo viene mappato a signature in AzureSASCredential.

options
ServiceBusClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.

Dettagli proprietà

fullyQualifiedNamespace

Spazio dei nomi completo dell'istanza del bus di servizio per cui viene creato il client. È probabile che sia simile a .servicebus.windows.net.

fullyQualifiedNamespace: string

Valore della proprietà

string

identifier

Nome utilizzato per identificare questo ServiceBusClient. Se non specificato o vuoto, verrà generato un univoco casuale.

identifier: string

Valore della proprietà

string

Dettagli metodo

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una coda di bus di servizio di Azure abilitata per la sessione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametri

queueName

string

Nome della coda da cui ricevere.

options
ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(defaulted to peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una sottoscrizione di bus di servizio di Azure abilitata per la sessione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametri

topicName

string

Nome dell'argomento per la sottoscrizione da cui si vuole ricevere.

subscriptionName

string

Nome della sottoscrizione (sotto ) topicda cui si vuole ricevere.

options
ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(defaulted to peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una sessione abilitata bus di servizio di Azure coda.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametri

queueName

string

Nome della coda da cui ricevere.

sessionId

string

ID della sessione da cui devono essere ricevuti i messaggi

options
ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(defaulted to peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una sessione abilitata bus di servizio di Azure sottoscrizione.

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parametri

topicName

string

Nome dell'argomento per la sottoscrizione da cui si vuole ricevere.

subscriptionName

string

Nome della sottoscrizione (sotto ) topicda cui si vuole ricevere.

sessionId

string

ID della sessione da cui devono essere ricevuti i messaggi

options
ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(defaulted to peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

close()

Chiude la connessione AMQP sottostante. NOTA: questa operazione disconnetterà anche eventuali istanze di ricevitore o mittente create da questa istanza.

function close(): Promise<void>

Restituisce

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Crea un ricevitore per una coda di bus di servizio di Azure. Nessuna connessione viene effettuata al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per indirizzare le sotto code, ad esempio la coda di lettere non recapitabili o la coda di messaggi non recapitabili, specificare le subQueue opzioni. Per altre informazioni sulle code di lettere non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

I messaggi che non vengono risolti all'interno della durata del blocco verranno ridistribuiti quante volte il numero massimo di recapito impostato nella coda, dopo il quale vengono inviati a una coda di messaggi non recapitabili separati.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametri

queueName

string

Nome della coda da cui ricevere.

options
ServiceBusReceiverOptions

Opzioni per passare il valore receiveMode, predefinito in peekLock.

Restituisce

ServiceBusReceiver

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

createReceiver(string, string, ServiceBusReceiverOptions)

Crea un ricevitore per una sottoscrizione bus di servizio di Azure. Nessuna connessione viene effettuata al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per indirizzare le sotto code, ad esempio la coda di lettere non recapitabili o la coda di messaggi non recapitabili, specificare le subQueue opzioni. Per altre informazioni sulle code di lettere non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

È possibile scegliere tra due modalità di ricezione: "peekLock" (impostazione predefinita) e "receiveAndDelete".

  • In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda.
  • In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

I messaggi che non vengono risolti entro la durata del blocco verranno ridistribuiti quante volte il numero massimo di recapito impostato nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separati.

È possibile risolvere un messaggio chiamando completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parametri

topicName

string

Nome dell'argomento per la sottoscrizione da cui si vuole ricevere.

subscriptionName

string

Nome della sottoscrizione (sotto ) topicda cui si vuole ricevere.

options
ServiceBusReceiverOptions

Opzioni per passare il valore receiveMode, predefinito in peekLock.

Restituisce

ServiceBusReceiver

Ricevitore che può essere usato per ricevere, leggere e risolvere i messaggi.

createRuleManager(string, string)

Crea un'istanza di ServiceBusRuleManager usata per gestire le regole per una sottoscrizione.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Parametri

topicName

string

argomento per creare ServiceBusRuleManager

subscriptionName

string

sottoscrizione specifica dell'argomento specificato per creare un ServiceBusRuleManager per.

Restituisce

ServiceBusRuleManager

un oggetto ServiceBusRuleManager con ambito nella sottoscrizione e nell'argomento specificato.

createSender(string, ServiceBusSenderOptions)

Crea un mittente che può essere usato per inviare messaggi, pianificare l'invio di messaggi in un secondo momento e annullare tali messaggi pianificati. Nessuna connessione al servizio finché non viene chiamato uno dei metodi del mittente.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Parametri

queueOrTopicName

string

Nome di una coda o di un argomento a cui inviare messaggi.

options
ServiceBusSenderOptions

Restituisce

ServiceBusSender