@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: время ожидания в миллисекундах до истечения времени ожидания операции. Это активирует повторную попытку, если еще есть какие-либо повторные попытки. Минимальное значение: 60 000 миллисекунда.
ServiceBusConnectionStringProperties	Набор свойств, составляющих строку подключения служебной шины.
ServiceBusMessage	Описывает сообщение, которое будет отправлено в служебную шину.
ServiceBusMessageBatch	Пакет сообщений, которые можно создать с помощью <xref:createBatch> метода .
ServiceBusReceivedMessage	Описывает сообщение, полученное из служебной шины во время операций просмотра, поэтому его невозможно урегулировать.
ServiceBusReceiver	Получатель, который не обрабатывает сеансы.
ServiceBusReceiverOptions	Параметры, используемые при создании приемника.
ServiceBusRuleManager	Разрешает управление правилами для подписки. Для этого диспетчера правил требуются только утверждения Listen, тогда как ServiceBusAdministrationClient требует утверждения Manage.
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. Параметры для настройки трассировки и abortSignal.
RawHttpHeaders	Коллекция HttpHeaders, представленная в виде простого объекта JSON.
ServiceBusErrorCode	Коды сбоев служебной шины.
SqlRuleAction	Представляет все возможные поля в SqlRuleAction.
TransferProgressEvent	Срабатывает в ответ на ход отправки или скачивания.
WithResponse	Представляет возвращенный ответ операции вместе с необработанным ответом.

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

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

Функции

delay<T>(number, AbortSignalLike, string, T)	Оболочка для setTimeout, которая разрешает обещание после t миллисекунда.
isServiceBusError(unknown)	Определяет, имеет ли ошибка тип ServiceBusError
parseServiceBusConnectionString(string)	Анализирует указанную строку подключения в различные свойства, применимые к Служебная шина Azure. Эти свойства полезны для последующего создания ServiceBusClient.

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

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

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

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

Параметры

delayInMs

number

Число миллисекундах для задержки.

abortSignal

AbortSignalLike

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

abortErrorMsg

string

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

value

T

Значение, с которым необходимо разрешить по истечении времени ожидания 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

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

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

ServiceBusConnectionStringProperties