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

ConnectionString class

包:

azure-iot-common

介绍使设备或云应用程序能够连接到 Azure IoT 中心的参数。

属性

DeviceId	设备标识注册表中存在的唯一设备标识符。 这仅用于设备连接字符串。
GatewayHostName	充当设备或协议网关的主机的 IP 地址或 Internet 名称。 与 Azure Edge 设备通信时使用。
HostName	Azure IoT 中心的主机名。
ModuleId	设备标识注册表中存在的唯一模块标识符。 这仅用于设备连接字符串。
SharedAccessKey	用于创建共享访问签名令牌的对称密钥，这些令牌又用于对连接进行身份验证。 与特定设备或特定服务策略相关联。
SharedAccessKeyName	用于连接到 Azure IoT 中心的访问策略的名称。 仅在服务 SDK 的情况下使用，而设备 SDK 未使用（它改用 DeviceId）。
SharedAccessSignature	一个共享访问签名，用于封装 IoT 中心的“设备连接”权限。
x509	仅当设备使用 x509 证书进行身份验证且该证书存在时，此属性才会设置为 True。

方法

parse(string, string[])

分析字符串并返回相应的 ConnectionString 对象。

属性详细信息

DeviceId

设备标识注册表中存在的唯一设备标识符。 这仅用于设备连接字符串。

DeviceId?: string

属性值

string

GatewayHostName

充当设备或协议网关的主机的 IP 地址或 Internet 名称。 与 Azure Edge 设备通信时使用。

GatewayHostName?: string

属性值

string

HostName

Azure IoT 中心的主机名。

HostName?: string

属性值

string

ModuleId

设备标识注册表中存在的唯一模块标识符。 这仅用于设备连接字符串。

ModuleId?: string

属性值

string

SharedAccessKey

用于创建共享访问签名令牌的对称密钥，这些令牌又用于对连接进行身份验证。 与特定设备或特定服务策略相关联。

SharedAccessKey?: string

属性值

string

SharedAccessKeyName

用于连接到 Azure IoT 中心的访问策略的名称。 仅在服务 SDK 的情况下使用，而设备 SDK 未使用（它改用 DeviceId）。

SharedAccessKeyName?: string

属性值

string

SharedAccessSignature

一个共享访问签名，用于封装 IoT 中心的“设备连接”权限。

SharedAccessSignature?: string

属性值

string

x509

仅当设备使用 x509 证书进行身份验证且该证书存在时，此属性才会设置为 True。

x509?: string

属性值

string

方法详细信息

parse(string, string[])

分析字符串并返回相应的 ConnectionString 对象。

static function parse(source: string, requiredFields?: string[]): ConnectionString

参数

source

string

将从中提取连接字符串的字符串

requiredFields

string[]

列出应找到的字段的字符串数组。

返回

ConnectionString