Share via

TransportConfig interface

  • Reference
Package:
azure-iot-common

Configuration structure used by transports and AuthenticationProvider objects to store and exchange credentials.

Properties

deviceId

Device unique identifier.
gatewayHostName

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

Hostname of the Azure IoT hub instance.
moduleId

Module unique identifier.
sharedAccessKey

Shared access key is used to sign security tokens.
sharedAccessKeyName

Name of the policy which shared access key is used to sign security tokens.
sharedAccessSignature

Shared access signature security token used to authenticate a device when token-based authentication is used.
x509

Object containing the certificate and key used by the device to connect and authenticate with the Azure IoT hub instance.

Property Details

deviceId

Device unique identifier.

deviceId: string

Property Value

string

gatewayHostName

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

string

host

Hostname of the Azure IoT hub instance.

host: string

Property Value

string

moduleId

Module unique identifier.

moduleId?: string

Property Value

string

sharedAccessKey

Shared access key is used to sign security tokens.

sharedAccessKey?: string

Property Value

string

sharedAccessKeyName

Name of the policy which shared access key is used to sign security tokens.

sharedAccessKeyName?: string

Property Value

string

sharedAccessSignature

Shared access signature security token used to authenticate a device when token-based authentication is used.

sharedAccessSignature?: string

Property Value

string

x509

Object containing the certificate and key used by the device to connect and authenticate with the Azure IoT hub instance.

x509?: X509

Property Value

X509