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

EventHubsConnectionStringBuilder 类

定义

EventHubsConnectionStringBuilder 可用于构造可以与事件中心实体建立通信的连接字符串。 它还可用于对现有连接字符串执行基本验证。

连接字符串基本上是由由“;”分隔的键值对组成的字符串。 基本格式为“<key>=<value>[;<key>=<value>]“,其中支持的密钥名称如下所示:

终结点 - 包含事件中心命名空间的 URL

EntityPath - 事件中心实体的路径

SharedAccessKeyName - 命名空间或实体的相应共享访问策略规则的密钥名称。

SharedAccessKey - 命名空间或实体的相应共享访问策略规则的密钥。
public class EventHubsConnectionStringBuilder
type EventHubsConnectionStringBuilder = class
Public Class EventHubsConnectionStringBuilder
继承
EventHubsConnectionStringBuilder

示例

示例代码:

var connectionStringBuiler = new EventHubsConnectionStringBuilder(
    "amqps://EventHubsNamespaceName.servicebus.windows.net", 
    "EventHubsEntityName", // Event Hub Name 
    "SharedAccessSignatureKeyName", 
    "SharedAccessSignatureKey");
 string connectionString = connectionStringBuiler.ToString();

构造函数

EventHubsConnectionStringBuilder(String)

ConnectionString 格式:Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY

EventHubsConnectionStringBuilder(Uri, String, String, String)

生成易耗用的连接字符串 CreateFromConnectionString(String)

EventHubsConnectionStringBuilder(Uri, String, String, String, TimeSpan)

生成易耗用的连接字符串 CreateFromConnectionString(String)

EventHubsConnectionStringBuilder(Uri, String, String, TimeSpan)

生成易耗用的连接字符串 CreateFromConnectionString(String)

属性

Authentication

在设置为“托管标识”时启用 Azure Active Directory 托管标识身份验证

Endpoint

获取或设置事件中心终结点。

EntityPath

从连接字符串获取实体路径值

OperationTimeout

OperationTimeout 在错误情况下应用,以通知调用方相关情况 EventHubsException

SasKey

从连接字符串获取共享访问策略密钥值

SasKeyName

从连接字符串获取共享访问策略所有者名称

SharedAccessSignature

获取或设置 SAS 访问令牌。

TransportType

客户端连接的传输类型。 可允许的选项包括 Amqp 和 AmqpWebSocket。 如果未指定,则默认为 Amqp。

方法

Clone()

创建当前 EventHubsConnectionStringBuilder的克隆对象。

ToString()

返回可用于连接到事件中心命名空间的可互操作连接字符串

适用于