ConnectionString class

Unique device identifier as it exists in the device identity registry. This is only used for device connection strings.

DeviceId?: string

Property Value

IP address or internet name of the host machine working as a device or protocol gateway. Used when communicating with Azure Edge devices.

GatewayHostName?: string

Property Value

Hostname of the Azure IoT hub.

HostName?: string

Property Value

Unique module identifier as it exists in the device identity registry. This is only used for device connection strings.

ModuleId?: string

Property Value

Symmetric key used to create shared access signature tokens that are in turn used to authenticate the connection. Associated either with a specific device or a specific service policy.

SharedAccessKey?: string

Property Value

Name of the access policy used to connect to the Azure IoT hub. used only in the case of the service SDK, unused with the Device SDK (which uses DeviceId instead).

SharedAccessKeyName?: string

Property Value

A shared access signature which encapsulates "device connect" permissions on an IoT hub.

SharedAccessSignature?: string

Property Value

This property exists only if a device uses x509 certificates for authentication and if it exists, will be set to True.

x509?: string

Property Value

Parses a string and returns the corresponding ConnectionString object.

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

Parameters

Returns