DiscoveredAssetProperties interface

Defines the discovered asset properties.

Properties

assetEndpointProfileRef

A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name.

datasets

Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set.

defaultDatasetsConfiguration

Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here.

defaultEventsConfiguration

Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here.

defaultTopic

Object that describes the default topic information for the asset.

discoveryId

Identifier used to detect changes in the asset.

documentationUri

Reference to the documentation.

events

Array of events that are part of the asset. Each event can have per-event configuration.

hardwareRevision

Revision number of the hardware.

manufacturer

Asset manufacturer name.

manufacturerUri

Asset manufacturer URI.

model

Asset model name.

productCode

Asset product code.

provisioningState

Provisioning state of the resource.

serialNumber

Asset serial number.

softwareRevision

Revision number of the software.

version

An integer that is incremented each time the resource is modified.

Property Details

assetEndpointProfileRef

A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name.

assetEndpointProfileRef: string

Property Value

string

datasets

Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set.

datasets?: DiscoveredDataset[]

Property Value

defaultDatasetsConfiguration

Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here.

defaultDatasetsConfiguration?: string

Property Value

string

defaultEventsConfiguration

Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here.

defaultEventsConfiguration?: string

Property Value

string

defaultTopic

Object that describes the default topic information for the asset.

defaultTopic?: Topic

Property Value

discoveryId

Identifier used to detect changes in the asset.

discoveryId: string

Property Value

string

documentationUri

Reference to the documentation.

documentationUri?: string

Property Value

string

events

Array of events that are part of the asset. Each event can have per-event configuration.

events?: DiscoveredEvent[]

Property Value

hardwareRevision

Revision number of the hardware.

hardwareRevision?: string

Property Value

string

manufacturer

Asset manufacturer name.

manufacturer?: string

Property Value

string

manufacturerUri

Asset manufacturer URI.

manufacturerUri?: string

Property Value

string

model

Asset model name.

model?: string

Property Value

string

productCode

Asset product code.

productCode?: string

Property Value

string

provisioningState

Provisioning state of the resource.

provisioningState?: string

Property Value

string

serialNumber

Asset serial number.

serialNumber?: string

Property Value

string

softwareRevision

Revision number of the software.

softwareRevision?: string

Property Value

string

version

An integer that is incremented each time the resource is modified.

version: number

Property Value

number