你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/service-bus package

参考

类

MessagingError	描述消息传送错误的基类。
ServiceBusAdministrationClient	所有作都会返回解析为具有相关输出的对象的承诺。这些对象还具有一个名为 `_response` 的属性，如果要从服务访问直接响应，可以使用该属性。
ServiceBusClient	一个客户端，可创建发送方实例，用于将消息发送到队列和主题以及接收方实例，以便从队列和订阅接收消息。
ServiceBusError	服务总线中发生的错误。

接口

AuthorizationRule	表示基于 ATOM 的管理作中的 `AuthorizationRule` 类型。
CorrelationRuleFilter	表示相关筛选器表达式。 CorrelationRuleFilter 保存一组条件，这些条件与订阅中传入消息的用户和系统属性匹配。
CreateMessageBatchOptions	在 `Sender`上配置 `createBatch` 方法的选项。 `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`：用于通过 Web 套接字配置 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	发送者可用于发送邮件、计划稍后发送的消息并取消此类计划邮件。使用 ServiceBusClient 上的 `createSender` 函数实例化发送方。 Sender 类是基础 AMQP 发送方链接的抽象。
ServiceBusSenderOptions	创建发件人时要使用的选项。
ServiceBusSessionReceiver	处理会话的接收器，包括续订会话锁。
ServiceBusSessionReceiverOptions	介绍在使用启用了会话的队列/订阅时传递给 `acceptSession` 和 `acceptNextSession` 方法的选项。
SqlRuleFilter	表示 SqlRuleFilter 上的所有可能字段
SubscribeOptions	订阅服务总线队列或订阅时使用的选项。
SubscriptionProperties	表示 updateSubscription 的输入。
SubscriptionRuntimeProperties	表示订阅实体的运行时信息属性
TokenCredential	表示能够提供身份验证令牌的凭据。
TopicProperties	表示 updateTopic 的输入。
TopicRuntimeProperties	表示主题实体的运行时信息属性
TryAddOptions	用于手动传播分布式跟踪 `Span` 上下文的选项集。
WebResourceLike	要向远程服务器发出的 HTTP 请求的说明。
WebSocketImpl	描述 WebSocket 构造函数所需的形状。
WebSocketOptions	用于通过 Web 套接字配置 AMQP 连接的通道的选项。

类型别名

EntitiesResponse	表示对实体的列表作的结果，这些实体还包含从中开始循环访问的 `continuationToken`。
EntityAvailabilityStatus	服务总线消息传送实体 `availabilityStatus` 的可能值。
EntityStatus	服务总线消息传送实体 `status` 的可能值。
OperationOptionsBase	注意：此类型旨在镜像来自 `@azure/core-client` OperationOptions 的相关字段和结构用于配置跟踪和中止的选项。
RawHttpHeaders	表示为简单 JSON 对象的 HttpHeaders 集合。
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

通过