通过

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

CbsClient class

  • 参考
包:
@azure/core-amqp

介绍通过 AMQP 连接与$cbs终结点通信的 EventHub/ServiceBus Cbs 客户端。

构造函数

CbsClient(Connection, string)

属性

cbsLock

每个连接$cbs会话的唯一锁名称，用于获取用于建立 cbs 会话的锁（如果 amqp 连接不存在）。
connection

AMQP 连接。
connectionLock

每个连接的唯一锁名称，用于获取用于建立 amqp 连接的锁（如果不存在）。
endpoint

CBS 终结点 - “$cbs”
replyTo

CBS replyTo - 服务应答复的接收方链接名称。

方法

close()

关闭此客户端的 EventHub/ServiceBus 的 AMQP cbs 会话，返回将在断开连接完成时解决的承诺。
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

如果之前未在给定连接上初始化 CBS 会话的单一实例，则创建该实例。
isOpen()

指示 cbs 发送方接收方链接是打开还是关闭。
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

与 EventHub/ServiceBus 服务协商 CBS 声明。
remove()

删除此客户端的 EventHub/ServiceBus 的 AMQP cbs 会话，

构造函数详细信息

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

参数

connection

Connection

AMQP 连接。

connectionLock

string

唯一字符串 (通常是每个连接的 guid) 。

属性详细信息

cbsLock

每个连接$cbs会话的唯一锁名称，用于获取用于建立 cbs 会话的锁（如果 amqp 连接不存在）。

cbsLock: string

属性值

string

connection

AMQP 连接。

connection: Connection

属性值

Connection

connectionLock

每个连接的唯一锁名称，用于获取用于建立 amqp 连接的锁（如果不存在）。

connectionLock: string

属性值

string

endpoint

CBS 终结点 - “$cbs”

endpoint: string

属性值

string

replyTo

CBS replyTo - 服务应答复的接收方链接名称。

replyTo: string

属性值

string

方法详细信息

close()

关闭此客户端的 EventHub/ServiceBus 的 AMQP cbs 会话，返回将在断开连接完成时解决的承诺。

function close(): Promise<void>

返回

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

如果之前未在给定连接上初始化 CBS 会话的单一实例，则创建该实例。

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

参数

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

可用于影响此方法行为的可选参数。 例如， abortSignal 可以传递 以允许取消正在进行的 init 调用。

返回

Promise<void>

承诺。

isOpen()

指示 cbs 发送方接收方链接是打开还是关闭。

function isOpen(): boolean

返回

boolean

true 打开、 false 关闭。

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

与 EventHub/ServiceBus 服务协商 CBS 声明。

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

参数

audience

string

以下列形式之一请求令牌的实体令牌受众：

  • ServiceBus

    • 发送方

      • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
      • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • 接收机 - "sb://<yournamespace>.servicebus.windows.net/<queue-name>" - "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • ManagementClient - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management"。 - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

  • EventHubs

    • 发送方

      • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
      • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>".

    • 接收方

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

    • ManagementClient

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".
token

string

需要在 put-token 请求中发送的令牌。

tokenType
TokenType

使用的令牌类型。 例如，“jwt”或“servicebus.windows.net：sastoken”。

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

可用于影响此方法行为的可选参数。 例如， abortSignal 可以传递 以允许取消正在进行的 negotiateClaim 调用。

返回

Promise<CbsResponse>

承诺，在$cbs身份验证成功时解决，在$cbs身份验证期间出错时拒绝。

remove()

删除此客户端的 EventHub/ServiceBus 的 AMQP cbs 会话，

function remove()