Поделиться через


@azure/service-bus package

Классы

MessagingError

Описывает базовый класс для ошибки обмена сообщениями.

ServiceBusAdministrationClient

Все операции возвращают обещания, разрешающие объекту с соответствующими выходными данными. Эти объекты также имеют свойство с именем _response, которое можно использовать, если вы хотите получить прямой ответ от службы.

ServiceBusClient

Клиент, который может создавать экземпляры отправителя для отправки сообщений в очереди и разделы, а также экземпляры получателя для получения сообщений из очередей и подписок.

ServiceBusError

Ошибки, возникающие в служебной шине.

Интерфейсы

AuthorizationRule

Представляет тип AuthorizationRule в операциях управления на основе ATOM.

CorrelationRuleFilter

Представляет выражение фильтра корреляции. CorrelationRuleFilter содержит набор условий, которые соответствуют свойствам пользователя и системы входящих сообщений из подписки.

CreateMessageBatchOptions

Параметры настройки метода createBatch в Sender.

  • maxSizeInBytes: верхний предел размера пакета.

Пример использования:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
CreateQueueOptions

Представляет параметры набора в очереди

CreateSubscriptionOptions

Представляет параметры набора в подписке

CreateTopicOptions

Представляет параметры набора в разделе

DeadLetterOptions

Описывает причину и описание ошибки для недоставки сообщения с помощью метода deadLetter() сообщения, полученного из служебной шины.

Delivery
GetMessageIteratorOptions

Параметры при получении итератора с помощью итератора служебной шины.

HttpHeader

Отдельный заголовок в коллекции HttpHeaders.

HttpHeadersLike

Коллекция пар ключей и значений заголовка HTTP.

HttpResponse

Свойства http-ответа, который всегда будет присутствовать.

MessageHandlers

Общий интерфейс обработчика сообщений (используется для streamMessages).

NamespaceProperties

Представляет метаданные, связанные с пространством имен служебной шины.

OperationOptions

Базовый тип параметров для всех операций.

PeekMessagesOptions

Описывает параметры, передаваемые методу peekMessages приемника.

ProcessErrorArgs

Аргументы обратного вызова processError.

QueueProperties

Представляет входные данные для updateQueue.

QueueRuntimeProperties

Представляет атрибуты сведений о среде выполнения сущности очереди

ReceiveMessagesOptions

Параметры при получении пакета сообщений из служебной шины.

RetryOptions

Параметры политики повторных попыток, определяющие режим, количество повторных попыток, интервал повторных попыток и т. д.

RuleProperties

Представляет все атрибуты правила.

ServiceBusAdministrationClientOptions

Представляет параметры клиента ServiceBusAdministrationClient.

ServiceBusClientOptions

Описывает параметры, которые можно предоставить при создании ServiceBusClient.

  • webSocketOptions. Параметры настройки канала подключения AMQP через веб-сокеты.
    • websocket: конструктор WebSocket, используемый для создания подключения AMQP, если вы решили сделать подключение через WebSocket.
    • webSocketConstructorOptions. Параметры передачи в конструктор Websocket при выборе подключения через WebSocket.
  • retryOptions: параметры повторных попыток для всех операций на клиенте.
    • maxRetries: количество попыток, которые можно выполнить при повторной ошибке.
    • maxRetryDelayInMs: максимальная задержка между повторными попытками. Применимо только при выполнении экспоненциальных повторных попыток.
    • mode: какой режим повторных попыток применяется, указанный перечислением RetryMode. Параметры: Exponential и Fixed. По умолчанию используется Fixed.
    • retryDelayInMs: время ожидания в миллисекундах перед выполнением следующей попытки. Если mode задано значение Exponential, это используется для вычисления экспоненциально увеличивающихся задержек между повторными попытками. Значение по умолчанию: 30000 миллисекунда.
    • timeoutInMs: время ожидания в миллисекундах до истечения времени ожидания операции. Это приведет к возникновению повторных попыток при наличии оставшихся попыток повторных попыток. Минимальное значение: 60000 миллисекунда.
ServiceBusConnectionStringProperties

Набор свойств, составляющих строку подключения служебной шины.

ServiceBusMessage

Описывает сообщение, которое будет отправлено в служебную шину.

ServiceBusMessageBatch

Пакет сообщений, которые можно создать с помощью метода <xref:createBatch>.

ServiceBusReceivedMessage

Описывает сообщение, полученное из служебной шины во время операций просмотра и поэтому не может быть решено.

ServiceBusReceiver

Приемник, который не обрабатывает сеансы.

ServiceBusReceiverOptions

Параметры, используемые при создании приемника.

ServiceBusRuleManager

Позволяет управлять правилами для управляемой подписки. Для этого диспетчера правил требуются только утверждения прослушивания, в то время как ServiceBusAdministrationClient требует управления утверждениями.

ServiceBusSender

Отправитель может использоваться для отправки сообщений, планирования отправки сообщений в дальнейшем и отмены таких запланированных сообщений. Используйте функцию createSender в ServiceBusClient, чтобы создать экземпляр отправителя. Класс Sender — это абстракция по базовой ссылке отправителя AMQP.

ServiceBusSenderOptions

Параметры, используемые при создании отправителя.

ServiceBusSessionReceiver

Приемник, обрабатывающий сеансы, включая продление блокировки сеанса.

ServiceBusSessionReceiverOptions

Описывает параметры, передаваемые в методы acceptSession и acceptNextSession при использовании очереди или подписки с включенными сеансами.

SqlRuleFilter

Представляет все возможные поля в SqlRuleFilter

SubscribeOptions

Параметры, используемые при подписке на очередь или подписку служебной шины.

SubscriptionProperties

Представляет входные данные для updateSubscription.

SubscriptionRuntimeProperties

Представляет атрибуты сведений о среде выполнения сущности подписки

TokenCredential

Представляет учетные данные, способные предоставлять маркер проверки подлинности.

TopicProperties

Представляет входные данные для updateTopic.

TopicRuntimeProperties

Представляет атрибуты сведений о среде выполнения сущности раздела

TryAddOptions

Набор параметров для распространения Span контекста вручную для распределенной трассировки.

WebResourceLike

Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.

WebSocketImpl

Описывает необходимую форму конструкторов WebSocket.

WebSocketOptions

Параметры настройки канала подключения AMQP через веб-сокеты.

Псевдонимы типа

EntitiesResponse

Представляет результат операции списка для сущностей, которые также содержат continuationToken для начала итерации.

EntityAvailabilityStatus

Возможные значения для availabilityStatus сущностей обмена сообщениями служебной шины.

EntityStatus

Возможные значения для status сущностей обмена сообщениями служебной шины.

OperationOptionsBase

ПРИМЕЧАНИЕ. Этот тип предназначен для зеркального отображения соответствующих полей и структуры из @azure/core-client OperationOptions

Параметры настройки трассировки и прерывания.

RawHttpHeaders

Коллекция HttpHeaders, представленная как простой объект JSON.

ServiceBusErrorCode

Коды сбоев служебной шины.

SqlRuleAction

Представляет все возможные поля в SqlRuleAction

TransferProgressEvent

Активируется в ответ на ход отправки или скачивания.

WithResponse

Представляет возвращаемый ответ операции вместе с необработанным ответом.

Перечисления

RetryMode

Описание типа режима повтора

TokenType

Описывает тип поддерживаемых маркеров.

Функции

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

Оболочка для setTimeout, разрешающая обещание после миллисекунда.

isServiceBusError(unknown)

Определяет, является ли ошибка типом ServiceBusError

parseServiceBusConnectionString(string)

Анализирует заданную строку подключения в различные свойства, применимые к служебной шине Azure. Затем свойства полезны для создания ServiceBusClient.

Сведения о функции

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

Оболочка для setTimeout, разрешающая обещание после миллисекунда.

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

Параметры

delayInMs

number

Число отложенных миллисекундах.

abortSignal
AbortSignalLike

ПрерываниеSignal, связанное с содержащей операцией.

abortErrorMsg

string

Сообщение об ошибке прерывания, связанное с содержащей операцией.

value

T

Значение, которое необходимо устранить после истечения времени ожидания миллисекунда.

Возвращаемое значение

Promise<T | void>

  • Разрешенное обещание

isServiceBusError(unknown)

Определяет, является ли ошибка типом ServiceBusError

function isServiceBusError(err: unknown): err

Параметры

err

unknown

Ошибка, чтобы проверить, является ли она типом ServiceBusError

Возвращаемое значение

err

parseServiceBusConnectionString(string)

Анализирует заданную строку подключения в различные свойства, применимые к служебной шине Azure. Затем свойства полезны для создания ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Параметры

connectionString

string

Строка подключения, связанная с политикой общего доступа, созданной для пространства имен служебной шины, очереди или раздела.

Возвращаемое значение