ConnectionString class

套件:

azure-iot-common

描述可讓裝置或雲端應用程式連線到 Azure IoT 中樞的參數。

屬性

DeviceId	裝置身分識別登錄中存在的唯一裝置識別碼。 這只適用于裝置連接字串。
GatewayHostName	作為裝置或通訊協定閘道運作之主機電腦的 IP 位址或網際網路名稱。 與 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 位址或網際網路名稱。 與 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