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

@azure/amqp-common package

类

AsyncLock
AadTokenProvider	定义 AAD （Azure ActiveDirectory） TokenProvider。这接受 `@azure/ms-rest-nodeauth` 包中的以下凭据： ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials （MSIVmTokenCredentials）
CbsClient
DefaultDataTransformer	Azure SDK 将使用的默认数据转换器。
MessagingError	描述消息传送错误的基类。
RequestResponseLink	描述通过 amqp 会话创建的 amqp 请求（sender）-response（接收方）链接。
SasTokenProvider
Timeout	描述一个 Timeout 类，该类可以等待指定的时间量，然后使用给定值解析/拒绝承诺。

接口

AsyncLockOptions
ConnectionConfig	描述在分析 EventHub 或 ServiceBus 连接字符串后创建的连接配置对象。
ConnectionContextBase
EventHubConnectionConfig	描述分析 EventHub 连接字符串后创建的连接配置对象。它还提供了一些方便的方法，用于获取不同实体的地址和受众。
MessageHeader	描述消息的标准标头属性集。
MessageProperties	描述消息的已定义标准属性集。
AmqpMessage	描述在网络上发送或接收的 AMQP 消息。
AmqpMessageHeader	描述消息的标准标头属性集。
AmqpMessageProperties	描述消息的已定义标准属性集。
AsyncLockOptions	描述可用于创建异步锁的选项。
CbsResponse	描述 CBS 响应。
ConnectionConfigOptions	描述创建连接配置时可以提供的选项。
ConnectionProperties	定义建立 AMQP 连接时需要设置的属性。
CreateConnectionContextBaseParameters	描述可用于创建基本连接上下文的参数。
DataTransformer	描述在将数据发送到（或从）网络接收数据之前，可以执行对数据进行编码/解码的转换。
Dictionary	提供字典，如类型 T 的结构 <键、值>。
EventHubConnectionStringModel	描述 eventhub 连接字符串模型。
IotHubConnectionStringModel	描述 iothub 连接字符串模型。
RetryConfig	描述需要为重试操作配置的参数。
SendRequestOptions	描述发送请求时可以指定的选项。
ServiceBusConnectionStringModel	描述 servicebus 连接字符串模型。
StorageConnectionStringModel	介绍简介连接字符串模型。
TokenInfo	提供有关令牌的信息。
TokenProvider	描述基本令牌提供程序。

类型别名

AsyncLockDoneCallback
Func	函数类型的类型声明，其中 T 是函数的输入，V 是函数的输出。
ParsedOutput	定义一个对象，该对象具有在 T 中定义的可能属性。

枚举

ConditionErrorNameMapper	将 amqp 错误条件映射到错误名称。
ConditionStatusMapper	将条件映射到数值 AMQP 响应状态代码。
ErrorNameConditionMapper	将错误名称映射到 amqp 错误条件。
RetryOperationType	描述重试操作类型。 RetryOperationType
SystemErrorConditionMapper	将一些 SytemErrors 映射到 amqp 错误条件 SystemErrorConditionMapper
TokenType	描述支持的令牌类型。 TokenType

函数

delay<T>(number, T)	setTimeout 的包装器，用于解析 t 毫秒后的承诺。
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	获取具有所需设置的异步锁的新实例。
isAmqpError(any)	确定给定的错误对象是否与 AmqpError 对象类似。
isIotHubConnectionString(string)	确定给定的连接字符串是否为 iothub 连接字符串。
isSystemError(any)
parseConnectionString<T>(string)	分析连接字符串并返回 T 类型的对象。连接字符串具有以下语法： ConnectionString ：：= Part { “;”Part } [ “;” ][ WhiteSpace ]Part ：：= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ：：= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ：：= ？除 < a0/> 之外的任何字符序列或 = 或空格？ WhiteSpace ：：= ？所有空格字符，包括 \r 和 \n？
randomNumberFromInterval(number, number)	在给定间隔之间生成随机数
retry<T>(RetryConfig<T>)	它将尝试以线性方式重试指定的操作次数，并在每次重试之间出现指定的延迟。仅当错误可重试时，重试才会发生。
translate(Error \| AmqpError)	将协议层收到的 AQMP 错误或通用错误转换为 MessagingError。

变量

defaultLock
isNode	一个常数，用来表示环境是 node.js 还是基于浏览器。
retryableErrors	提供可重试的AMQP错误列表。 “内部服务器错误”、“服务器繁忙错误”、“服务不可用错误”、“作取消错误”、“发送者事务错误”、“消息错误”、“强制分离错误”、“连接强制错误”、“传输限制超额错误”、“作超时错误”

函数详细信息

delay<T>(number, T)

setTimeout 的包装器，用于解析 t 毫秒后的承诺。

function delay<T>(t: number, value?: T): Promise<T>

参数

t: number

要延迟的毫秒数。

value: T

要在超时时间为 t 毫秒后解析的值。

Promise<T>

已解决的承诺

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

参数

promiseFactories: any[]

kickstart: any

Promise<any>

getNewAsyncLock(AsyncLockOptions)

获取具有所需设置的异步锁的新实例。

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

参数

options: AsyncLockOptions

异步锁选项。

AsyncLock

isAmqpError(any)

确定给定的错误对象是否与 AmqpError 对象类似。

function isAmqpError(err: any): boolean

参数

err: any

AmqpError 对象

boolean

result - 如果它是 AMQP 错误，则 true;否则 false。

isIotHubConnectionString(string)

确定给定的连接字符串是否为 iothub 连接字符串。

function isIotHubConnectionString(connectionString: string): boolean

参数

connectionString: string

连接字符串。

boolean

布尔。

isSystemError(any)

function isSystemError(err: any): boolean

参数

err: any

boolean

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<T>。

randomNumberFromInterval(number, number)

在给定间隔之间生成随机数

function randomNumberFromInterval(min: number, max: number): number

参数

min: number

范围（含）的最小值。

max: number

范围的最大数目（含）。

number

retry<T>(RetryConfig<T>)

它将尝试以线性方式重试指定的操作次数，并在每次重试之间出现指定的延迟。仅当错误可重试时，重试才会发生。

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

参数

config: RetryConfig<T>

配置重试操作的参数。

Promise<T>

承诺<T>.

translate(Error | AmqpError)

将协议层收到的 AQMP 错误或通用错误转换为 MessagingError。

function translate(err: Error | AmqpError): MessagingError

参数

err: Error | AmqpError

收到的 amqp 错误。

MessagingError

MessagingError 对象。

Variable Details

defaultLock

defaultLock: AsyncLock

类型

AsyncLock

isNode

一个常数，用来表示环境是 node.js 还是基于浏览器。

isNode: boolean

类型

boolean

retryableErrors

提供可重试的AMQP错误列表。 “内部服务器错误”、“服务器繁忙错误”、“服务不可用错误”、“作取消错误”、“发送者事务错误”、“消息错误”、“强制分离错误”、“连接强制错误”、“传输限制超额错误”、“作超时错误”

retryableErrors: string[]

类型

string[]

反馈

此页面是否有帮助？