Share via

AssetUpdateProperties interface

  • Reference
Package:
@azure/arm-deviceregistry

The updatable properties of the Asset.

Properties

attributes

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

Array of datasets that are part of the asset. Each dataset 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.
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 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.
serialNumber

Asset serial number.
softwareRevision

Revision number of the software.

Property Details

attributes

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

attributes?: Record<string, any>

Property Value

Record<string, any>

datasets

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

datasets?: Dataset[]

Property Value

Dataset[]

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

Topic

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 have per-event configuration.

events?: Event[]

Property Value

Event[]

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

serialNumber

Asset serial number.

serialNumber?: string

Property Value

string

softwareRevision

Revision number of the software.

softwareRevision?: string

Property Value

string