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

@azure/core-amqp package

参考

类

CbsClient	介绍通过 AMQP 连接与 $cbs 终结点通信的 EventHub/ServiceBus Cbs 客户端。
MessagingError	描述消息传送错误的基类。
RequestResponseLink	描述通过 amqp 会话创建的 amqp 请求（sender）-response（接收方）链接。

接口

AcquireLockProperties	描述获取锁时必须提供的属性。
AmqpAnnotatedMessage	描述 ServiceBusReceivedMessage 的 AmqpAnnotatedMessage（作为 `amqpAnnotatedMessage` 属性）的一部分。
AmqpMessageHeader	描述消息的标准标头属性集。
AmqpMessageProperties	描述消息的已定义标准属性集。
CancellableAsyncLock	CancellableAsyncLock 提供了一种机制，用于强制使用相同的“密钥”来串行执行任务。可以通过中止手动取消挂起的任务，也可以通过达到提供的超时值自动取消。
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 ：：= ？除 < a0/> 之外的任何字符序列或 = 或空格？ WhiteSpace ：：= ？所有空格字符，包括 `\r` 和 `\n`？
retry<T>(RetryConfig<T>)	每次作至少尝试一次。如果上一次尝试失败并出现可重试错误，则会进行其他尝试。其他尝试次数受 `RetryConfig` 参数上提供的 `maxRetries` 属性的约束。如果 `mode` 选项设置为 `Fixed`，则会对给定作进行多次重试，每次重试之间的固定延迟。如果 `mode` 选项设置为 `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 ：：= ？除 < a0/> 之外的任何字符序列或 = 或空格？ WhiteSpace ：：= ？所有空格字符，包括 \r 和 \n？

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

参数

connectionString: string

要分析的连接字符串。

ParsedOutput<T>

ParsedOutput。

retry<T>(RetryConfig<T>)

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

如果 mode 选项设置为 Fixed，则会对给定作进行多次重试，每次重试之间的固定延迟。

如果 mode 选项设置为 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 对象。

通过