ConnectionString class

Pakiet:

azure-iot-common

Opisuje parametry, które umożliwiają urządzeniu lub aplikacji w chmurze łączenie się z centrum Azure IoT Hub.

Właściwości

DeviceId	Unikatowy identyfikator urządzenia, który istnieje w rejestrze tożsamości urządzeń. Jest to używane tylko w przypadku parametrów połączenia urządzenia.
GatewayHostName	Adres IP lub nazwa internetowa maszyny hosta działającej jako brama urządzenia lub protokołu. Używany podczas komunikowania się z urządzeniami usługi Azure Edge.
HostName	Nazwa hosta centrum Azure IoT Hub.
ModuleId	Unikatowy identyfikator modułu, który istnieje w rejestrze tożsamości urządzeń. Jest to używane tylko w przypadku parametrów połączenia urządzenia.
SharedAccessKey	Klucz symetryczny używany do tworzenia tokenów sygnatury dostępu współdzielonego, które są z kolei używane do uwierzytelniania połączenia. Skojarzone z określonym urządzeniem lub określonymi zasadami usługi.
SharedAccessKeyName	Nazwa zasad dostępu używanych do nawiązywania połączenia z centrum Azure IoT Hub. używany tylko w przypadku zestawu SDK usługi, nieużywany z zestawem Device SDK (który używa DeviceId zamiast tego).
SharedAccessSignature	Sygnatura dostępu współdzielonego, która hermetyzuje uprawnienia "łączenie urządzenia" w centrum IoT.
x509	Ta właściwość istnieje tylko wtedy, gdy urządzenie używa certyfikatów x509 do uwierzytelniania i jeśli istnieje, zostanie ustawiona wartość True.

Metody

parse(string, string[])

Analizuje ciąg i zwraca odpowiedni obiekt ConnectionString.

Szczegóły właściwości

DeviceId

Unikatowy identyfikator urządzenia, który istnieje w rejestrze tożsamości urządzeń. Jest to używane tylko w przypadku parametrów połączenia urządzenia.

DeviceId?: string

Wartość właściwości

string

GatewayHostName

Adres IP lub nazwa internetowa maszyny hosta działającej jako brama urządzenia lub protokołu. Używany podczas komunikowania się z urządzeniami usługi Azure Edge.

GatewayHostName?: string

Wartość właściwości

string

HostName

Nazwa hosta centrum Azure IoT Hub.

HostName?: string

Wartość właściwości

string

ModuleId

Unikatowy identyfikator modułu, który istnieje w rejestrze tożsamości urządzeń. Jest to używane tylko w przypadku parametrów połączenia urządzenia.

ModuleId?: string

Wartość właściwości

string

SharedAccessKey

Klucz symetryczny używany do tworzenia tokenów sygnatury dostępu współdzielonego, które są z kolei używane do uwierzytelniania połączenia. Skojarzone z określonym urządzeniem lub określonymi zasadami usługi.

SharedAccessKey?: string

Wartość właściwości

string

SharedAccessKeyName

Nazwa zasad dostępu używanych do nawiązywania połączenia z centrum Azure IoT Hub. używany tylko w przypadku zestawu SDK usługi, nieużywany z zestawem Device SDK (który używa DeviceId zamiast tego).

SharedAccessKeyName?: string

Wartość właściwości

string

SharedAccessSignature

Sygnatura dostępu współdzielonego, która hermetyzuje uprawnienia "łączenie urządzenia" w centrum IoT.

SharedAccessSignature?: string

Wartość właściwości

string

x509

Ta właściwość istnieje tylko wtedy, gdy urządzenie używa certyfikatów x509 do uwierzytelniania i jeśli istnieje, zostanie ustawiona wartość True.

x509?: string

Wartość właściwości

string

Szczegóły metody

parse(string, string[])

Analizuje ciąg i zwraca odpowiedni obiekt ConnectionString.

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

Parametry

source

string

parametry, z których zostaną wyodrębnione parametry połączenia

requiredFields

string[]

tablica ciągów z listą pól, które mają zostać znalezione.

Zwraca

ConnectionString