Freigeben über

ConnectionString class

  • Referenz
Paket:
azure-iot-common

Beschreibt die Parameter, mit denen ein Gerät oder eine Cloudanwendung eine Verbindung mit einem Azure IoT Hub herstellen kann.

Eigenschaften

DeviceId

Eindeutiger Gerätebezeichner, wie er in der Geräteidentitätsregistrierung vorhanden ist. Dies wird nur für Geräteverbindungszeichenfolgen verwendet.
GatewayHostName

IP-Adresse oder Internetname des Hostcomputers, der als Gerät oder Protokollgateway arbeitet. Wird bei der Kommunikation mit Azure Edge-Geräten verwendet.
HostName

Hostname des Azure IoT Hubs.
ModuleId

Eindeutiger Modulbezeichner, wie er in der Geräteidentitätsregistrierung vorhanden ist. Dies wird nur für Geräteverbindungszeichenfolgen verwendet.
SharedAccessKey

Symmetrischer Schlüssel, der zum Erstellen von Shared Access Signature Token verwendet wird, die wiederum zum Authentifizieren der Verbindung verwendet werden. Entweder einem bestimmten Gerät oder einer bestimmten Dienstrichtlinie zugeordnet.
SharedAccessKeyName

Name der Zugriffsrichtlinie, die zum Herstellen einer Verbindung mit dem Azure IoT Hub verwendet wird. wird nur im Fall des Dienst-SDK verwendet, nicht mit dem Device SDK (das stattdessen verwendet wird DeviceId ).
SharedAccessSignature

Eine freigegebene Zugriffssignatur, die die Berechtigungen "Geräteverbindung" für einen IoT Hub kapselt.
x509

Diese Eigenschaft ist nur vorhanden, wenn ein Gerät x509-Zertifikate für die Authentifizierung verwendet und wenn es vorhanden ist, wird auf True festgelegt.

Methoden

parse(string, string[])

Analysiert eine Zeichenfolge und gibt das entsprechende ConnectionString Objekt zurück.

Details zur Eigenschaft

DeviceId

Eindeutiger Gerätebezeichner, wie er in der Geräteidentitätsregistrierung vorhanden ist. Dies wird nur für Geräteverbindungszeichenfolgen verwendet.

DeviceId?: string

Eigenschaftswert

string

GatewayHostName

IP-Adresse oder Internetname des Hostcomputers, der als Gerät oder Protokollgateway arbeitet. Wird bei der Kommunikation mit Azure Edge-Geräten verwendet.

GatewayHostName?: string

Eigenschaftswert

string

HostName

Hostname des Azure IoT Hubs.

HostName?: string

Eigenschaftswert

string

ModuleId

Eindeutiger Modulbezeichner, wie er in der Geräteidentitätsregistrierung vorhanden ist. Dies wird nur für Geräteverbindungszeichenfolgen verwendet.

ModuleId?: string

Eigenschaftswert

string

SharedAccessKey

Symmetrischer Schlüssel, der zum Erstellen von Shared Access Signature Token verwendet wird, die wiederum zum Authentifizieren der Verbindung verwendet werden. Entweder einem bestimmten Gerät oder einer bestimmten Dienstrichtlinie zugeordnet.

SharedAccessKey?: string

Eigenschaftswert

string

SharedAccessKeyName

Name der Zugriffsrichtlinie, die zum Herstellen einer Verbindung mit dem Azure IoT Hub verwendet wird. wird nur im Fall des Dienst-SDK verwendet, nicht mit dem Device SDK (das stattdessen verwendet wird DeviceId ).

SharedAccessKeyName?: string

Eigenschaftswert

string

SharedAccessSignature

Eine freigegebene Zugriffssignatur, die die Berechtigungen "Geräteverbindung" für einen IoT Hub kapselt.

SharedAccessSignature?: string

Eigenschaftswert

string

x509

Diese Eigenschaft ist nur vorhanden, wenn ein Gerät x509-Zertifikate für die Authentifizierung verwendet und wenn es vorhanden ist, wird auf True festgelegt.

x509?: string

Eigenschaftswert

string

Details zur Methode

parse(string, string[])

Analysiert eine Zeichenfolge und gibt das entsprechende ConnectionString Objekt zurück.

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

Parameter

source

string

Zeichenfolge, aus der die Verbindungszeichenfolge extrahiert wird

requiredFields

string[]

Array von Zeichenfolgen, die die Felder auflisten, die voraussichtlich gefunden werden sollen.

Gibt zurück

ConnectionString