@azure/service-bus package

Clases

MessagingError	Describe la clase base para Error de mensajería.
ServiceBusAdministrationClient	Todas las operaciones devuelven promesas que se resuelven en un objeto que tiene la salida pertinente. Estos objetos también tienen una propiedad denominada _response que puede usar si desea acceder a la respuesta directa desde el servicio.
ServiceBusClient	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.
ServiceBusError	Errores que se producen en Service Bus.

Interfaces

AuthorizationRule	Representa el tipo de AuthorizationRule en las operaciones de administración basadas en ATOM.
CorrelationRuleFilter	Representa la expresión de filtro de correlación. CorrelationRuleFilter contiene un conjunto de condiciones que coinciden con las propiedades del usuario y del sistema de los mensajes entrantes de una suscripción.
CreateMessageBatchOptions	Opciones para configurar el método createBatch en el Sender. maxSizeInBytes: límite superior del tamaño del lote. Uso de ejemplo: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Representa las opciones que se pueden establecer en una cola.
CreateSubscriptionOptions	Representa las opciones que se pueden establecer en una suscripción.
CreateTopicOptions	Representa opciones que se pueden establecer en un tema
DeadLetterOptions	Describe el motivo y la descripción del error para enviar mensajes fallidos a un mensaje mediante el método deadLetter() en el mensaje recibido de Service Bus.
Delivery
GetMessageIteratorOptions	Opciones al obtener un iterador iterable de Service Bus.
HttpHeader	Encabezado individual dentro de una colección HttpHeaders.
HttpHeadersLike	Colección de pares clave-valor de encabezado HTTP.
HttpResponse	Propiedades de una respuesta HTTP que siempre estará presente.
MessageHandlers	Interfaz del controlador de mensajes general (usada para streamMessages).
NamespaceProperties	Representa los metadatos relacionados con un espacio de nombres de Service Bus.
OperationOptions	Tipo de opciones base para todas las operaciones.
PeekMessagesOptions	Describe las opciones que se pasan al método peekMessages en un receptor.
ProcessErrorArgs	Argumentos para la devolución de llamada de processError.
QueueProperties	Representa la entrada de updateQueue.
QueueRuntimeProperties	Representa los atributos de información en tiempo de ejecución de una entidad de cola.
ReceiveMessagesOptions	Opciones al recibir un lote de mensajes de Service Bus.
RetryOptions	Opciones de directiva de reintento que determinan el modo, el número de reintentos, el intervalo de reintento, etc.
RuleProperties	Representa todos los atributos de una regla.
ServiceBusAdministrationClientOptions	Representa las opciones de cliente del ServiceBusAdministrationClient.
ServiceBusClientOptions	Describe las opciones que se pueden proporcionar al crear ServiceBusClient. webSocketOptions: opciones para configurar el canalización de la conexión AMQP a través de sockets web. websocket : el constructor WebSocket que se usa para crear una conexión AMQP si decide realizar la conexión a través de un WebSocket. webSocketConstructorOptions: opciones para pasar al constructor Websocket cuando se decide establecer la conexión a través de Un WebSocket. retryOptions: las opciones de reintento para todas las operaciones del cliente. maxRetries: número de veces que se puede reintentar la operación en caso de un error que se puede reintentar. maxRetryDelayInMs: el retraso máximo entre reintentos. Solo es aplicable al realizar reintentos exponenciales. mode: el modo de reintento que se va a aplicar, especificado por la enumeración RetryMode. Las opciones son Exponential y Fixed. El valor predeterminado es Fixed. retryDelayInMs: cantidad de tiempo de espera en milisegundos antes de realizar el siguiente intento. Cuando mode se establece en Exponential, se usa para calcular los retrasos que aumentan exponencialmente entre reintentos. Valor predeterminado: 30000 milisegundos. timeoutInMs: cantidad de tiempo en milisegundos que se esperarán antes de que se agote el tiempo de espera de la operación. Esto desencadenará un reintento si quedan intentos de reintento. Valor mínimo: 60000 milisegundos.
ServiceBusConnectionStringProperties	Conjunto de propiedades que componen una cadena de conexión de Service Bus.
ServiceBusMessage	Describe el mensaje que se va a enviar a Service Bus.
ServiceBusMessageBatch	Un lote de mensajes que puede crear mediante el método <xref:createBatch>.
ServiceBusReceivedMessage	Describe el mensaje recibido de Service Bus durante las operaciones de inspección, por lo que no se puede liquidar.
ServiceBusReceiver	Receptor que no controla las sesiones.
ServiceBusReceiverOptions	Opciones que se usarán al crear un receptor.
ServiceBusRuleManager	Permite administrar reglas para una suscripción. Este administrador de reglas solo requiere notificaciones de escucha, mientras que el ServiceBusAdministrationClient requiere administrar notificaciones.
ServiceBusSender	Un remitente se puede usar para enviar mensajes, programar que se envíen mensajes más adelante y cancelar dichos mensajes programados. Use la función createSender en ServiceBusClient para crear instancias de un remitente. La clase Sender es una abstracción sobre el vínculo de remitente de AMQP subyacente.
ServiceBusSenderOptions	Opciones que se usarán al crear un remitente.
ServiceBusSessionReceiver	Receptor que controla las sesiones, incluida la renovación del bloqueo de sesión.
ServiceBusSessionReceiverOptions	Describe las opciones que se pasan a los métodos acceptSession y acceptNextSession cuando se usa una cola o suscripción que tiene habilitadas las sesiones.
SqlRuleFilter	Representa todos los campos posibles en SqlRuleFilter
SubscribeOptions	Opciones que se usan al suscribirse a una cola o una suscripción de Service Bus.
SubscriptionProperties	Representa la entrada de updateSubscription.
SubscriptionRuntimeProperties	Representa los atributos de información en tiempo de ejecución de una entidad de suscripción.
TokenCredential	Representa una credencial capaz de proporcionar un token de autenticación.
TopicProperties	Representa la entrada de updateTopic.
TopicRuntimeProperties	Representa los atributos de información en tiempo de ejecución de una entidad de tema.
TryAddOptions	Conjunto de opciones para propagar manualmente Span contexto para el seguimiento distribuido.
WebResourceLike	Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.
WebSocketImpl	Describe la forma necesaria de los constructores de WebSocket.
WebSocketOptions	Opciones para configurar el canalización de la conexión AMQP a través de sockets web.

Alias de tipos

EntitiesResponse	Representa el resultado de la operación de lista en entidades que también contiene el continuationToken desde el que iniciar la iteración.
EntityAvailabilityStatus	Valores posibles para availabilityStatus de las entidades de mensajería de Service Bus.
EntityStatus	Valores posibles para status de las entidades de mensajería de Service Bus.
OperationOptionsBase	NOTA: Este tipo está pensado para reflejar los campos y la estructura pertinentes de @azure/core-client OperationOptions. Opciones para configurar el seguimiento y abortSignal.
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
ServiceBusErrorCode	Códigos de error de Service Bus.
SqlRuleAction	Representa todos los campos posibles en SqlRuleAction
TransferProgressEvent	Se desencadena en respuesta a la carga o descarga del progreso.
WithResponse	Representa la respuesta devuelta de la operación junto con la respuesta sin procesar.

Enumeraciones

RetryMode	Describe el tipo modo de reintento.
TokenType	Describe el tipo de tokens admitidos.

Funciones

delay<T>(number, AbortSignalLike, string, T)	Contenedor para setTimeout que resuelve una promesa después de milisegundos.
isServiceBusError(unknown)	Determina si un error es de tipo ServiceBusError
parseServiceBusConnectionString(string)	Analiza la cadena de conexión dada en las distintas propiedades aplicables a Azure Service Bus. Las propiedades son útiles para construir un ServiceBusClient.

Detalles de la función

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

Contenedor para setTimeout que resuelve una promesa después de milisegundos.

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

Parámetros

delayInMs

number

Número de milisegundos que se van a retrasar.

abortSignal

AbortSignalLike

AbortSignal asociado a la operación contenedora.

abortErrorMsg

string

Mensaje de error de anulación asociado a la operación contenedora.

value

T

Valor que se va a resolver con después de un tiempo de espera de milisegundos.

Devoluciones

Promise<T | void>

• Promesa resuelta

isServiceBusError(unknown)

Determina si un error es de tipo ServiceBusError

function isServiceBusError(err: unknown): err

Parámetros

err

unknown

Error para comprobar si es de tipo ServiceBusError.

Devoluciones

err

parseServiceBusConnectionString(string)

Analiza la cadena de conexión dada en las distintas propiedades aplicables a Azure Service Bus. Las propiedades son útiles para construir un ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Parámetros

connectionString

string

Cadena de conexión asociada a la directiva de acceso compartido creada para el espacio de nombres, cola o tema de Service Bus.

Devoluciones

ServiceBusConnectionStringProperties