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

@azure/core-amqp package

类

CbsClient	介绍通过 AMQP 连接与$cbs终结点通信的 EventHub/ServiceBus Cbs 客户端。
MessagingError	描述 Messaging Error 的基类。
RequestResponseLink	描述通过 amqp 会话创建的 amqp 请求 (发送方) 响应 (接收方) 链接。

接口

AcquireLockProperties	描述获取锁时必须提供的属性。
AmqpAnnotatedMessage	描述 AmqpAnnotatedMessage（ServiceBusReceivedMessage (的一部分）作为 amqpAnnotatedMessage 属性) 。
AmqpMessageHeader	描述消息的已定义标准标头属性集。
AmqpMessageProperties	描述消息的已定义标准属性集。
CancellableAsyncLock	CancellableAsyncLock 提供了一种机制，用于强制以串行方式执行使用同一“密钥”的任务。 可以通过 abortSignal 手动取消挂起的任务，也可以通过达到提供的超时值自动取消挂起的任务。
CbsResponse	描述 CBS 响应。
ConnectionConfig	描述在分析 EventHub 或 ServiceBus 连接字符串后创建的连接配置对象。
ConnectionConfigOptions	介绍创建连接配置时可以提供的选项。
ConnectionContextBase	提供基础 amqp 连接、cbs 会话、tokenProvider、连接配置、数据转换器等上下文信息。
ConnectionProperties	定义建立 AMQP 连接时需要设置的属性。
CreateConnectionContextBaseParameters	描述可用于创建基本连接上下文的参数。
NetworkSystemError	描述Node.js SystemError 上的字段。 省略与网络调用 (无关的字段，例如文件系统调用) 。 请参见https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	描述需要为重试操作配置的参数。
RetryOptions	用于确定模式、重试次数、重试间隔等的重试策略选项。
SendRequestOptions	描述发送请求时可以指定的选项。
WebSocketOptions	用于通过 Web 套接字配置 AMQP 连接的通道的选项。

类型别名

ParsedOutput

使用 T 中定义的可能属性定义对象。

枚举

ConditionErrorNameMapper	将 amqp 错误条件映射到错误名称。
ErrorNameConditionMapper	将错误名称映射到 amqp 错误条件。
RetryMode	介绍重试模式类型
RetryOperationType	描述重试操作类型。
SystemErrorConditionMapper	将一些 SystemErrors 映射到 amqp 错误条件
TokenType	描述支持的令牌的类型。

函数

delay<T>(number, AbortSignalLike, string, T)	setTimeout 的包装器，用于在 t 毫秒后解析承诺。
isMessagingError(MessagingError | Error)	确定错误是否为 MessagingError。
isSystemError(unknown)	检查提供的错误是否为node.js SystemError。
parseConnectionString<T>(string)	分析连接字符串并返回 T 类型的对象。 连接字符串具有以下语法： ConnectionString ：：= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ：：= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ：：= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ：：= ？ 除 之外的任何字符序列;或 = 或 WhiteSpace ？ WhiteSpace ：：= ？ 所有空格字符，包括 \r 和 \n ？
retry<T>(RetryConfig<T>)	每个操作至少尝试一次。 如果上一次尝试失败并出现可重试错误，则进行其他尝试。 其他尝试次数由 maxRetries 参数上 RetryConfig 提供的 属性控制。 如果 mode option 设置为 Fixed，则对给定操作进行指定次数的重试，每次重试之间的延迟固定。 如果 mode option 设置为 Exponential，则重试之间的延迟会进行调整，以随着每次尝试使用电源 2 的退避因子呈指数级增加。
translate(unknown)	将协议层或 SystemError 上收到的 AMQP 错误转换为 MessagingError。 所有其他错误均未更改返回。

函数详细信息

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>

• 已解决的承诺

isMessagingError(MessagingError | Error)

确定错误是否为 MessagingError。

function isMessagingError(error: MessagingError | Error): error

参数

error

MessagingError | Error

可以是 Error 或 MessagingError 的错误。

返回

error

isSystemError(unknown)

检查提供的错误是否为node.js SystemError。

function isSystemError(err: unknown): err

参数

err

unknown

可能包含错误信息的对象。

返回

err

parseConnectionString<T>(string)

分析连接字符串并返回 T 类型的对象。

连接字符串具有以下语法：

ConnectionString ：：= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ：：= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ：：= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ：：= ？ 除 之外的任何字符序列;或 = 或 WhiteSpace ？ WhiteSpace ：：= ？ 所有空格字符，包括 \r 和 \n ？

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

参数

connectionString

string

要分析的连接字符串。

返回

ParsedOutput<T>

ParsedOutput。

retry<T>(RetryConfig<T>)

每个操作至少尝试一次。 如果上一次尝试失败并出现可重试错误，则进行其他尝试。 其他尝试次数由 maxRetries 参数上 RetryConfig 提供的 属性控制。

如果 mode option 设置为 Fixed，则对给定操作进行指定次数的重试，每次重试之间的延迟固定。

如果 mode option 设置为 Exponential，则重试之间的延迟会进行调整，以随着每次尝试使用电源 2 的退避因子呈指数级增加。

function retry<T>(config: RetryConfig<T>): Promise<T>

参数

config

RetryConfig<T>

用于配置重试操作的参数

返回

Promise<T>

承诺。

translate(unknown)

将协议层或 SystemError 上收到的 AMQP 错误转换为 MessagingError。 所有其他错误均未更改返回。

function translate(err: unknown): MessagingError | Error

参数

err

unknown

收到的 amqp 错误。

返回

MessagingError | Error

MessagingError 对象。