通过

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

EventHubConnectionConfig interface

  • 参考
包:
@azure/amqp-common

描述在分析 EventHub 连接字符串后创建的连接配置对象。 它还提供了一些方便的方法，用于获取不同实体的地址和受众。

Extends
ConnectionConfig

属性

entityPath

实体的名称/路径 (需要连接到的事件中心名称) 。

继承属性

connectionString

连接字符串。
endpoint

服务总线终结点“sb：//.servicebus.windows.net/”。
host

主机“.servicebus.windows.net”。
sharedAccessKey

访问密钥的机密值。
sharedAccessKeyName

访问密钥的名称。
webSocket

用于通过 WebSocket 创建 AMQP 连接的 WebSocket 构造函数。 在浏览器中，默认使用内置 WebSocket。 在 Node 中，如果未提供 WebSocket 构造函数，将使用 TCP 套接字。
webSocketConstructorOptions

要传递给 WebSocket 构造函数的选项
webSocketEndpointPath

通过 WebSocket 接受 AMQP 连接的终结点的路径。

方法

getManagementAddress()

提供 EventHub 管理地址。

  • "<hub-name>/$management"
getManagementAudience()

提供 EventHub Management 受众。

  • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/$management"
getReceiverAddress(string | number, string)

提供 EventHub 接收方地址：

  • "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getReceiverAudience(string | number, string)

提供 EventHub 接收方受众。

  • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getSenderAddress(string | number)

根据输入以下列形式之一提供 EventHub 发件人地址：

  • "<hubName>"
  • "<hubName>/Partitions/<partitionId>"
getSenderAudience(string | number)

根据输入以下列形式之一提供 EventHub Sender 受众：

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

属性详细信息

entityPath

实体的名称/路径 (需要连接到的事件中心名称) 。

entityPath: string

属性值

string

继承属性详细信息

connectionString

连接字符串。

connectionString: string

属性值

string

继承自ConnectionConfig.connectionString

endpoint

服务总线终结点“sb：//.servicebus.windows.net/”。

endpoint: string

属性值

string

继承自ConnectionConfig.endpoint

host

主机“.servicebus.windows.net”。

host: string

属性值

string

继承自ConnectionConfig.host

sharedAccessKey

访问密钥的机密值。

sharedAccessKey: string

属性值

string

继承自ConnectionConfig.sharedAccessKey

sharedAccessKeyName

访问密钥的名称。

sharedAccessKeyName: string

属性值

string

继承自ConnectionConfig.sharedAccessKeyName

webSocket

用于通过 WebSocket 创建 AMQP 连接的 WebSocket 构造函数。 在浏览器中，默认使用内置 WebSocket。 在 Node 中，如果未提供 WebSocket 构造函数，将使用 TCP 套接字。

webSocket?: WebSocketImpl

属性值

WebSocketImpl

继承自ConnectionConfig.webSocket

webSocketConstructorOptions

要传递给 WebSocket 构造函数的选项

webSocketConstructorOptions?: any

属性值

any

继承自ConnectionConfig.webSocketConstructorOptions

webSocketEndpointPath

通过 WebSocket 接受 AMQP 连接的终结点的路径。

webSocketEndpointPath?: string

属性值

string

继承自ConnectionConfig.webSocketEndpointPath

方法详细信息

getManagementAddress()

提供 EventHub 管理地址。

  • "<hub-name>/$management"
function getManagementAddress(): string

返回

string

getManagementAudience()

提供 EventHub Management 受众。

  • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/$management"
function getManagementAudience(): string

返回

string

getReceiverAddress(string | number, string)

提供 EventHub 接收方地址：

  • "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
function getReceiverAddress(partitionId: string | number, consumergroup?: string): string

参数

partitionId

string | number

EventHub 中将从中接收消息的 partitionId。

consumergroup

string

将从中接收消息的 EventHub 中的使用者目标。 默认值：$default。

返回

string

getReceiverAudience(string | number, string)

提供 EventHub 接收方受众。

  • "sb://<your-namespace>.servicebus.windows.net/<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
function getReceiverAudience(partitionId: string | number, consumergroup?: string): string

参数

partitionId

string | number

EventHub 中将从中接收消息的 partitionId。

consumergroup

string

将从中接收消息的 EventHub 中的使用者目标。 默认值：$default。

返回

string

getSenderAddress(string | number)

根据输入以下列形式之一提供 EventHub 发件人地址：

  • "<hubName>"
  • "<hubName>/Partitions/<partitionId>"
function getSenderAddress(partitionId?: string | number): string

参数

partitionId

string | number

EventHub 中要向其发送消息的 partitionId。

返回

string

getSenderAudience(string | number)

根据输入以下列形式之一提供 EventHub Sender 受众：

  • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
  • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>"
function getSenderAudience(partitionId?: string | number): string

参数

partitionId

string | number

EventHub 中要向其发送消息的 partitionId。

返回

string