ServiceBusClient class

Pacchetto:

@azure/service-bus

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.

Costruttori

ServiceBusClient(string, ServiceBusClientOptions)	Crea un'istanza della classe ServiceBusClient che può essere usata per creare mittenti e ricevitori nello spazio dei nomi del bus di servizio di Azure fornito nella stringa di connessione. Non viene stabilita alcuna connessione al servizio finché non vengono usati i mittenti/ricevitori creati con il client 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 del bus di servizio di Azure fornito. Non viene stabilita alcuna connessione al servizio finché non vengono usati i mittenti/ricevitori creati con il client 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 <yournamespace.servicebus.windows.net>.
identifier	Nome utilizzato per identificare questo ServiceBusClient. Se non specificato o vuoto, verrà generato un valore univoco casuale.

Metodi

acceptNextSession(string, ServiceBusSessionReceiverOptions)	Crea un ricevitore per la sessione successiva disponibile in una coda del 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. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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 del 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. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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 coda del 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. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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 sottoscrizione del 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. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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 tutte le istanze di Ricevitore o Mittente create da questa istanza.
createReceiver(string, ServiceBusReceiverOptions)	Crea un ricevitore per una coda del bus di servizio di Azure. Non viene stabilita alcuna connessione al servizio finché non viene chiamato uno dei metodi nel ricevitore. Per specificare le code secondarie come la coda dei messaggi non recapitabili o la coda dei messaggi non recapitabili di trasferimento, specificare il subQueue nelle opzioni. Per altre informazioni sulle code di messaggi 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 recapitati ogni volta che il numero massimo di recapito impostato nella coda, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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 del bus di servizio di Azure. Non viene stabilita alcuna connessione al servizio finché non viene chiamato uno dei metodi nel ricevitore. Per specificare le code secondarie come la coda dei messaggi non recapitabili o la coda dei messaggi non recapitabili di trasferimento, specificare il subQueue nelle opzioni. Per altre informazioni sulle code di messaggi 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 recapitati ogni volta che il numero massimo di recapito impostato nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata. Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore. Altre informazioni sul funzionamento di peekLock e message settlement 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. Non viene stabilita alcuna 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 del bus di servizio di Azure fornito nella stringa di connessione. Non viene stabilita alcuna connessione al servizio finché non vengono usati i mittenti/ricevitori creati con il client per inviare/ricevere messaggi.

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

Parametri

connectionString

string

Stringa di connessione per lo spazio dei nomi del 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 del bus di servizio di Azure fornito. Non viene stabilita alcuna connessione al servizio finché non vengono usati i mittenti/ricevitori creati con il client per inviare/ricevere messaggi.

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

Parametri

fullyQualifiedNamespace

string

Lo spazio dei nomi completo dell'istanza di Service Bus, che probabilmente sarà simile a <yournamespace.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. Vedere @azure/identità per la creazione delle credenziali. Se si usa una propria implementazione dell'interfaccia TokenCredential su AAD, impostare gli "ambiti" per il bus di servizio in modo che sia ["https://servicebus.azure.net//user_impersonation"] per ottenere il token appropriato. Usare il AzureNamedKeyCredential da @azure/core-auth se si vuole passare un SharedAccessKeyName e SharedAccessKey senza usare una stringa di connessione. Questi campi eseguono il mapping rispettivamente al campo name e key in AzureNamedKeyCredential. Usare il AzureSASCredential da @azure/core-auth se si vuole passare un SharedAccessSignature senza usare una stringa di connessione. Questo campo esegue il mapping 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 tramite Web Socket.

Dettagli proprietà

fullyQualifiedNamespace

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

fullyQualifiedNamespace: string

Valore della proprietà

string

identifier

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

identifier: string

Valore della proprietà

string

Dettagli metodo

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una coda del 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.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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(impostazione predefinita per peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

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

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per la sessione successiva disponibile in una sottoscrizione del 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.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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 (nel topic) da cui si vuole ricevere.

options

ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(impostazione predefinita per peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una coda del 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.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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(impostazione predefinita per peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crea un ricevitore per una sottoscrizione del 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.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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 (nel topic) da cui si vuole ricevere.

sessionId

string

ID della sessione da cui devono essere ricevuti i messaggi

options

ServiceBusSessionReceiverOptions

Le opzioni includono receiveMode(impostazione predefinita per peekLock), opzioni per creare il ricevitore di sessione.

Restituisce

Promise<ServiceBusSessionReceiver>

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

close()

Chiude la connessione AMQP sottostante. NOTA: questa operazione disconnetterà anche tutte le 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 del bus di servizio di Azure. Non viene stabilita alcuna connessione al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per specificare le code secondarie come la coda dei messaggi non recapitabili o la coda dei messaggi non recapitabili di trasferimento, specificare il subQueue nelle opzioni. Per altre informazioni sulle code di messaggi 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 recapitati ogni volta che il numero massimo di recapito impostato nella coda, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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 receiveMode, impostazione predefinita peekLock.

Restituisce

ServiceBusReceiver

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

createReceiver(string, string, ServiceBusReceiverOptions)

Crea un ricevitore per una sottoscrizione del bus di servizio di Azure. Non viene stabilita alcuna connessione al servizio finché non viene chiamato uno dei metodi nel ricevitore.

Per specificare le code secondarie come la coda dei messaggi non recapitabili o la coda dei messaggi non recapitabili di trasferimento, specificare il subQueue nelle opzioni. Per altre informazioni sulle code di messaggi 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 recapitati ogni volta che il numero massimo di recapito impostato nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata.

Puoi risolvere un messaggio chiamando i metodi completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() nel ricevitore.

Altre informazioni sul funzionamento di peekLock e message settlement 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 (nel topic) da cui si vuole ricevere.

options

ServiceBusReceiverOptions

Opzioni per passare receiveMode, impostazione predefinita peekLock.

Restituisce

ServiceBusReceiver

Ricevitore che può essere usato per ricevere, visualizzare 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 la creazione di un ServiceBusRuleManager.

Restituisce

ServiceBusRuleManager

un ServiceBusRuleManager con ambito per la sottoscrizione e l'argomento specificati.

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. Non viene stabilita alcuna 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