Share via


InboundEndpoints interface

An endpoint to connect to the device.

Properties

additionalConfiguration

Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF).

address

The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com).

authentication

Defines the client authentication mechanism to the server.

endpointType

Type of connection endpoint.

trustSettings

Defines server trust settings for the endpoint.

version

Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc.

Property Details

additionalConfiguration

Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF).

additionalConfiguration?: string

Property Value

string

address

The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com).

address: string

Property Value

string

authentication

Defines the client authentication mechanism to the server.

authentication?: HostAuthentication

Property Value

endpointType

Type of connection endpoint.

endpointType: string

Property Value

string

trustSettings

Defines server trust settings for the endpoint.

trustSettings?: TrustSettings

Property Value

version

Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc.

version?: string

Property Value

string