Compartir a través de

ServiceBusClient class

  • Referencia
Paquete:
@azure/service-bus

Un cliente que puede crear instancias de remitente para enviar mensajes a colas y temas, así como instancias de Receiver para recibir mensajes de colas y suscripciones.

Constructores

ServiceBusClient(string, ServiceBusClientOptions)

Crea una instancia de la clase ServiceBusClient que se puede usar para crear remitentes y receptores en el espacio de nombres de Azure Service Bus proporcionado en la cadena de conexión. No se realiza ninguna conexión al servicio hasta que los remitentes o receptores creados con el cliente se usan para enviar o recibir mensajes.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Crea una instancia de la clase ServiceBusClient que se puede usar para crear remitentes y receptores en el espacio de nombres de Azure Service Bus proporcionado. No se realiza ninguna conexión al servicio hasta que los remitentes o receptores creados con el cliente se usan para enviar o recibir mensajes.

Propiedades

fullyQualifiedNamespace

Espacio de nombres completo de la instancia de Service Bus para la que se crea este cliente. Esto es probable que sea similar a .servicebus.windows.net.
identifier

Nombre que se usa para identificar este ServiceBusClient. Si no se especifica o está vacío, se generará uno único aleatorio.

Métodos

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crea un receptor para la siguiente sesión disponible en una cola de Azure Service Bus habilitada para sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para la siguiente sesión disponible en una suscripción de Azure Service Bus habilitada para sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para una cola de Azure Service Bus habilitada para la sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para una suscripción de Azure Service Bus habilitada para la sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Cierra la conexión AMQP subyacente. NOTA: Esto también desconectará cualquier instancia de Receptor o Remitente creada a partir de esta instancia.
createReceiver(string, ServiceBusReceiverOptions)

Crea un receptor para una cola de Azure Service Bus. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del receptor.

Para dirigirse a las sub colas como la cola de mensajes fallidos o la cola de mensajes fallidos de transferencia, proporcione el subQueue en las opciones. Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la cola, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)

Crea un receptor para una suscripción de Azure Service Bus. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del receptor.

Para dirigirse a las sub colas como la cola de mensajes fallidos o la cola de mensajes fallidos de transferencia, proporcione el subQueue en las opciones. Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)

Crea una instancia de serviceBusRuleManager que se usa para administrar las reglas de una suscripción.
createSender(string, ServiceBusSenderOptions)

Crea un remitente que se puede usar para enviar mensajes, programar los mensajes que se enviarán más adelante y cancelar dichos mensajes programados. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del remitente.

Detalles del constructor

ServiceBusClient(string, ServiceBusClientOptions)

Crea una instancia de la clase ServiceBusClient que se puede usar para crear remitentes y receptores en el espacio de nombres de Azure Service Bus proporcionado en la cadena de conexión. No se realiza ninguna conexión al servicio hasta que los remitentes o receptores creados con el cliente se usan para enviar o recibir mensajes.

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

Parámetros

connectionString

string

Cadena de conexión para el espacio de nombres de Azure Service Bus. NOTA: esta cadena de conexión puede contener una entityPath, que se omite.

options
ServiceBusClientOptions

Opciones para el cliente de Service Bus.

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

Crea una instancia de la clase ServiceBusClient que se puede usar para crear remitentes y receptores en el espacio de nombres de Azure Service Bus proporcionado. No se realiza ninguna conexión al servicio hasta que los remitentes o receptores creados con el cliente se usan para enviar o recibir mensajes.

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

Parámetros

fullyQualifiedNamespace

string

Espacio de nombres completo de la instancia de Service Bus que probablemente sea similar a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objeto de credencial que usa el cliente para obtener el token para autenticar la conexión con Azure Service Bus. Consulte @azure/identity para crear las credenciales. Si usa una implementación propia de la interfaz de TokenCredential en AAD, establezca los "ámbitos" para que service-bus sea ["https://servicebus.azure.net//user_impersonation"] para obtener el token adecuado. Use el AzureNamedKeyCredential de @azure/core-auth si desea pasar una SharedAccessKeyName y SharedAccessKey sin usar una cadena de conexión. Estos campos se asignan al campo name y key respectivamente en AzureNamedKeyCredential. Use el AzureSASCredential de @azure/core-auth si desea pasar una SharedAccessSignature sin usar una cadena de conexión. Este campo se asigna a signature en AzureSASCredential.

options
ServiceBusClientOptions

Conjunto de opciones que se aplicarán al configurar el cliente.

  • retryOptions : configura la directiva de reintento para todas las operaciones del cliente. Por ejemplo, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura el canalización de la conexión AMQP a través de sockets web.

Detalles de las propiedades

fullyQualifiedNamespace

Espacio de nombres completo de la instancia de Service Bus para la que se crea este cliente. Esto es probable que sea similar a .servicebus.windows.net.

fullyQualifiedNamespace: string

Valor de propiedad

string

identifier

Nombre que se usa para identificar este ServiceBusClient. Si no se especifica o está vacío, se generará uno único aleatorio.

identifier: string

Valor de propiedad

string

Detalles del método

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crea un receptor para la siguiente sesión disponible en una cola de Azure Service Bus habilitada para sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parámetros

queueName

string

Nombre de la cola de la que se va a recibir.

options
ServiceBusSessionReceiverOptions

Las opciones incluyen receiveMode(defaulted to peekLock), opciones para crear el receptor de sesión.

Devoluciones

Promise<ServiceBusSessionReceiver>

Receptor que se puede usar para recibir, ver y liquidar mensajes.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para la siguiente sesión disponible en una suscripción de Azure Service Bus habilitada para sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parámetros

topicName

string

Nombre del tema de la suscripción de la que queremos recibir.

subscriptionName

string

Nombre de la suscripción (en el topic) de la que queremos recibir.

options
ServiceBusSessionReceiverOptions

Las opciones incluyen receiveMode(defaulted to peekLock), opciones para crear el receptor de sesión.

Devoluciones

Promise<ServiceBusSessionReceiver>

Receptor que se puede usar para recibir, ver y liquidar mensajes.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para una cola de Azure Service Bus habilitada para la sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parámetros

queueName

string

Nombre de la cola de la que se va a recibir.

sessionId

string

Identificador de la sesión desde la que se deben recibir los mensajes.

options
ServiceBusSessionReceiverOptions

Las opciones incluyen receiveMode(defaulted to peekLock), opciones para crear el receptor de sesión.

Devoluciones

Promise<ServiceBusSessionReceiver>

Receptor que se puede usar para recibir, ver y liquidar mensajes.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crea un receptor para una suscripción de Azure Service Bus habilitada para la sesión.

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: 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>

Parámetros

topicName

string

Nombre del tema de la suscripción de la que queremos recibir.

subscriptionName

string

Nombre de la suscripción (en el topic) de la que queremos recibir.

sessionId

string

Identificador de la sesión desde la que se deben recibir los mensajes.

options
ServiceBusSessionReceiverOptions

Las opciones incluyen receiveMode(defaulted to peekLock), opciones para crear el receptor de sesión.

Devoluciones

Promise<ServiceBusSessionReceiver>

Receptor que se puede usar para recibir, ver y liquidar mensajes.

close()

Cierra la conexión AMQP subyacente. NOTA: Esto también desconectará cualquier instancia de Receptor o Remitente creada a partir de esta instancia.

function close(): Promise<void>

Devoluciones

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Crea un receptor para una cola de Azure Service Bus. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del receptor.

Para dirigirse a las sub colas como la cola de mensajes fallidos o la cola de mensajes fallidos de transferencia, proporcione el subQueue en las opciones. Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la cola, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parámetros

queueName

string

Nombre de la cola de la que se va a recibir.

options
ServiceBusReceiverOptions

Opciones para pasar receiveMode, con el valor predeterminado peekLock.

Devoluciones

ServiceBusReceiver

Receptor que se puede usar para recibir, ver y liquidar mensajes.

createReceiver(string, string, ServiceBusReceiverOptions)

Crea un receptor para una suscripción de Azure Service Bus. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del receptor.

Para dirigirse a las sub colas como la cola de mensajes fallidos o la cola de mensajes fallidos de transferencia, proporcione el subQueue en las opciones. Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Puede elegir entre dos modos de recepción: "peekLock" (valor predeterminado) y "receiveAndDelete".

  • En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola.
  • En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a los métodos completeMessage(), abandonMessage(), deferMessage() o deadletterMessage() en el receptor.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

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

Parámetros

topicName

string

Nombre del tema de la suscripción de la que queremos recibir.

subscriptionName

string

Nombre de la suscripción (en el topic) de la que queremos recibir.

options
ServiceBusReceiverOptions

Opciones para pasar receiveMode, con el valor predeterminado peekLock.

Devoluciones

ServiceBusReceiver

Receptor que se puede usar para recibir, ver y liquidar mensajes.

createRuleManager(string, string)

Crea una instancia de serviceBusRuleManager que se usa para administrar las reglas de una suscripción.

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

Parámetros

topicName

string

el tema para crear serviceBusRuleManager

subscriptionName

string

la suscripción específica del tema especificado para crear un ServiceBusRuleManager.

Devoluciones

ServiceBusRuleManager

un ServiceBusRuleManager ámbito de la suscripción y el tema especificados.

createSender(string, ServiceBusSenderOptions)

Crea un remitente que se puede usar para enviar mensajes, programar los mensajes que se enviarán más adelante y cancelar dichos mensajes programados. No se realiza ninguna conexión al servicio hasta que se llama a uno de los métodos del remitente.

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

Parámetros

queueOrTopicName

string

Nombre de una cola o tema al que se van a enviar mensajes.

options
ServiceBusSenderOptions

Devoluciones

ServiceBusSender