AssetProperties interface

Package:

@azure/arm-deviceregistry

Defines the 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.
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.
discoveredAssetRefs	Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided.
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.
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.
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.
uuid	Globally unique, immutable, non-reusable id.
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

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

discoveredAssetRefs

Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided.

discoveredAssetRefs?: 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[]

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.

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.

status?: AssetStatus

Property Value

AssetStatus

uuid

Globally unique, immutable, non-reusable id.

uuid?: string

Property Value

string

version

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

version?: number

Property Value

number