AssetProperties interface

Defines the asset properties.

Properties

assetEndpointProfileUri

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 have the format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>.

assetType

Resource path to asset type (model) definition.

attributes

A set of key-value pairs that contain custom attributes set by the customer.

dataPoints

Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.

defaultDataPointsConfiguration

Protocol-specific default configuration for all data points. Each data point can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.

defaultEventsConfiguration

Protocol-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.

description

Human-readable description of the asset.

displayName

Human-readable display name.

documentationUri

Reference to the documentation.

enabled

Enabled/Disabled status of the asset.

events

Array of events that are part of the asset. Each event can reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.

externalAssetId

Asset id provided by the customer.

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. NOTE: This property will not be serialized. It can only be populated by the server.

serialNumber

Asset serial number.

softwareRevision

Revision number of the software.

status

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. NOTE: This property will not be serialized. It can only be populated by the server.

uuid

Globally unique, immutable, non-reusable id. NOTE: This property will not be serialized. It can only be populated by the server.

version

An integer that is incremented each time the resource is modified. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

assetEndpointProfileUri

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 have the format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>.

assetEndpointProfileUri: string

Property Value

string

assetType

Resource path to asset type (model) definition.

assetType?: string

Property Value

string

attributes

A set of key-value pairs that contain custom attributes set by the customer.

attributes?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

dataPoints

Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.

dataPoints?: DataPoint[]

Property Value

defaultDataPointsConfiguration

Protocol-specific default configuration for all data points. Each data point can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.

defaultDataPointsConfiguration?: string

Property Value

string

defaultEventsConfiguration

Protocol-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.

defaultEventsConfiguration?: string

Property Value

string

description

Human-readable description of the asset.

description?: string

Property Value

string

displayName

Human-readable display name.

displayName?: string

Property Value

string

documentationUri

Reference to the documentation.

documentationUri?: string

Property Value

string

enabled

Enabled/Disabled status of the asset.

enabled?: boolean

Property Value

boolean

events

Array of events that are part of the asset. Each event can reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.

events?: Event_2[]

Property Value

Event[]

externalAssetId

Asset id provided by the customer.

externalAssetId?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

status

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. NOTE: This property will not be serialized. It can only be populated by the server.

status?: AssetStatus

Property Value

uuid

Globally unique, immutable, non-reusable id. NOTE: This property will not be serialized. It can only be populated by the server.

uuid?: string

Property Value

string

version

An integer that is incremented each time the resource is modified. NOTE: This property will not be serialized. It can only be populated by the server.

version?: number

Property Value

number