TransportConfig interface
Configuration structure used by transports and AuthenticationProvider objects to store and exchange credentials.
Properties
| device |
Device unique identifier. |
| gateway |
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. |
| module |
Module unique identifier. |
| shared |
Shared access key is used to sign security tokens. |
| shared |
Name of the policy which shared access key is used to sign security tokens. |
| shared |
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: stringProperty 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?: stringProperty Value
string
host
Hostname of the Azure IoT hub instance.
host: stringProperty Value
string
moduleId
Module unique identifier.
moduleId?: stringProperty Value
string
sharedAccessKey
Shared access key is used to sign security tokens.
sharedAccessKey?: stringProperty Value
string
sharedAccessKeyName
Name of the policy which shared access key is used to sign security tokens.
sharedAccessKeyName?: stringProperty Value
string
sharedAccessSignature
Shared access signature security token used to authenticate a device when token-based authentication is used.
sharedAccessSignature?: stringProperty 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