Class Asset

Namespace

Azure.Iot.Operations.Services.Assets

Assembly

Azure.Iot.Operations.Services.dll

public record Asset : IEquatable<Asset>

Inheritance

object

Asset

Implements

IEquatable<Asset>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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

public string? AssetEndpointProfileRef { get; set; }

Property Value

string

Attributes

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

public Dictionary<string, string>? Attributes { get; set; }

Property Value

Dictionary<string, string>

Datasets

public Dataset[]? Datasets { get; set; }

Property Value

Dataset[]

DatasetsDictionary

The mapping of dataset names to datasets that are part of the asset. Each dataset can have per-dataset configuration.

[JsonIgnore]
public Dictionary<string, Dataset>? DatasetsDictionary { get; }

Property Value

Dictionary<string, Dataset>

DefaultDatasetsConfiguration

Protocol-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here.

[JsonConverter(typeof(JsonDocumentConverter))]
public JsonDocument? DefaultDatasetsConfiguration { get; set; }

Property Value

JsonDocument

DefaultEventsConfiguration

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

[JsonConverter(typeof(JsonDocumentConverter))]
public JsonDocument? DefaultEventsConfiguration { get; set; }

Property Value

JsonDocument

DefaultTopic

Object that describes the topic information.

public Topic? DefaultTopic { get; set; }

Property Value

Topic

Description

Human-readable description of the asset.

public string? Description { get; set; }

Property Value

string

DiscoveredAssetRefs

Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow.

public string[]? DiscoveredAssetRefs { get; set; }

Property Value

string[]

DisplayName

Human-readable display name.

public string? DisplayName { get; set; }

Property Value

string

DocumentationUri

Reference to the documentation.

public string? DocumentationUri { get; set; }

Property Value

string

Enabled

Enabled/Disabled status of the asset.

public bool? Enabled { get; set; }

Property Value

bool?

Events

public Event[]? Events { get; set; }

Property Value

Event[]

EventsDictionary

The mapping of event names to events in this asset.

[JsonIgnore]
public Dictionary<string, Event>? EventsDictionary { get; }

Property Value

Dictionary<string, Event>

ExternalAssetId

Asset id provided by the customer.

public string? ExternalAssetId { get; set; }

Property Value

string

HardwareRevision

Revision number of the hardware.

public string? HardwareRevision { get; set; }

Property Value

string

Manufacturer

Asset manufacturer name.

public string? Manufacturer { get; set; }

Property Value

string

ManufacturerUri

Asset manufacturer URI.

public string? ManufacturerUri { get; set; }

Property Value

string

Model

Asset model name.

public string? Model { get; set; }

Property Value

string

ProductCode

Asset product code.

public string? ProductCode { get; set; }

Property Value

string

ProvisioningState

Provisioning state of the resource.

public string? ProvisioningState { get; set; }

Property Value

string

SerialNumber

Asset serial number.

public string? SerialNumber { get; set; }

Property Value

string

SoftwareRevision

Revision number of the software.

public string? SoftwareRevision { get; set; }

Property Value

string

Status

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

public Status? Status { get; set; }

Property Value

Status

Uuid

Globally unique, immutable, non-reusable id.

public string? Uuid { get; set; }

Property Value

string

Version

A value that is incremented each time the resource is modified.

public long? Version { get; set; }

Property Value

long?