Share via

NamespaceAssetProperties interface

Package:
@azure/arm-deviceregistry

Defines the asset properties.

Properties

assetTypeRefs

URIs or type definition IDs.
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.
defaultDatasetsDestinations

Default destinations for a dataset.
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.
defaultEventsDestinations

Default destinations for an event.
defaultManagementGroupsConfiguration

Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here.
defaultStreamsConfiguration

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

Default destinations for a stream.
description

Human-readable description of the asset.
deviceRef

Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use.
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

Asset documentation reference.
enabled

Enabled/disabled status of the asset.
eventGroups

Array of event groups that are part of the asset. Each event group can have per-event group configuration.
externalAssetId

Asset ID provided by the customer.
hardwareRevision

Asset hardware revision number.
lastTransitionTime

A timestamp (in UTC) that is updated each time the resource is modified.
managementGroups

Array of management groups that are part of the asset. Each management group can have a per-group configuration.
manufacturer

Asset manufacturer.
manufacturerUri

Asset manufacturer URI.
model

Asset model.
productCode

Asset product code.
provisioningState

Provisioning state of the resource.
serialNumber

Asset serial number.
softwareRevision

Asset software revision number.
status

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
streams

Array of streams that are part of the asset. Each stream can have a per-stream configuration.
uuid

Globally unique, immutable, non-reusable ID.
version

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

Property Details

assetTypeRefs

URIs or type definition IDs.

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

Property Value

NamespaceDataset[]

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

defaultDatasetsDestinations

Default destinations for a dataset.

defaultDatasetsDestinations?: DatasetDestinationUnion[]

Property Value

DatasetDestinationUnion[]

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

defaultEventsDestinations

Default destinations for an event.

defaultEventsDestinations?: EventDestinationUnion[]

Property Value

EventDestinationUnion[]

defaultManagementGroupsConfiguration

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

defaultManagementGroupsConfiguration?: string

Property Value

string

defaultStreamsConfiguration

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

defaultStreamsConfiguration?: string

Property Value

string

defaultStreamsDestinations

Default destinations for a stream.

defaultStreamsDestinations?: StreamDestinationUnion[]

Property Value

StreamDestinationUnion[]

description

Human-readable description of the asset.

description?: string

Property Value

string

deviceRef

Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use.

deviceRef: DeviceRef

Property Value

DeviceRef

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

Asset documentation reference.

documentationUri?: string

Property Value

string

enabled

Enabled/disabled status of the asset.

enabled?: boolean

Property Value

boolean

eventGroups

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

eventGroups?: NamespaceEventGroup[]

Property Value

NamespaceEventGroup[]

externalAssetId

Asset ID provided by the customer.

externalAssetId?: string

Property Value

string

hardwareRevision

Asset hardware revision number.

hardwareRevision?: string

Property Value

string

lastTransitionTime

A timestamp (in UTC) that is updated each time the resource is modified.

lastTransitionTime?: Date

Property Value

Date

managementGroups

Array of management groups that are part of the asset. Each management group can have a per-group configuration.

managementGroups?: ManagementGroup[]

Property Value

ManagementGroup[]

manufacturer

Asset manufacturer.

manufacturer?: string

Property Value

string

manufacturerUri

Asset manufacturer URI.

manufacturerUri?: string

Property Value

string

model

Asset model.

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

Asset software revision number.

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?: NamespaceAssetStatus

Property Value

NamespaceAssetStatus

streams

Array of streams that are part of the asset. Each stream can have a per-stream configuration.

streams?: NamespaceStream[]

Property Value

NamespaceStream[]

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