Class DiscoveredAsset

Namespace

Azure.Iot.Operations.Services.AssetAndDeviceRegistry.AdrBaseService

Assembly

Azure.Iot.Operations.Services.dll

public class DiscoveredAsset : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

DiscoveredAsset

Implements

IJsonOnDeserialized

IJsonOnSerializing

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AssetTypeRefs

URIs or type definition IDs for the asset type.

[JsonPropertyName("assetTypeRefs")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<string>? AssetTypeRefs { get; set; }

Property Value

List<string>

Attributes

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

[JsonPropertyName("attributes")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Dictionary<string, string>? Attributes { get; set; }

Property Value

Dictionary<string, string>

Datasets

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

[JsonPropertyName("datasets")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DiscoveredAssetDataset>? Datasets { get; set; }

Property Value

List<DiscoveredAssetDataset>

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.

[JsonPropertyName("defaultDatasetsConfiguration")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DefaultDatasetsConfiguration { get; set; }

Property Value

string

DefaultDatasetsDestinations

Default destinations for a dataset.

[JsonPropertyName("defaultDatasetsDestinations")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DatasetDestination>? DefaultDatasetsDestinations { get; set; }

Property Value

List<DatasetDestination>

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.

[JsonPropertyName("defaultEventsConfiguration")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DefaultEventsConfiguration { get; set; }

Property Value

string

DefaultEventsDestinations

Default destinations for an event.

[JsonPropertyName("defaultEventsDestinations")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<EventStreamDestination>? DefaultEventsDestinations { get; set; }

Property Value

List<EventStreamDestination>

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.

[JsonPropertyName("defaultManagementGroupsConfiguration")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DefaultManagementGroupsConfiguration { get; set; }

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.

[JsonPropertyName("defaultStreamsConfiguration")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DefaultStreamsConfiguration { get; set; }

Property Value

string

DefaultStreamsDestinations

Default destinations for a stream.

[JsonPropertyName("defaultStreamsDestinations")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<EventStreamDestination>? DefaultStreamsDestinations { get; set; }

Property Value

List<EventStreamDestination>

DeviceRef

[JsonPropertyName("deviceRef")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonRequired]
public AssetDeviceRef DeviceRef { get; set; }

Property Value

AssetDeviceRef

DocumentationUri

Asset documentation reference.

[JsonPropertyName("documentationUri")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DocumentationUri { get; set; }

Property Value

string

Events

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

[JsonPropertyName("events")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DiscoveredAssetEvent>? Events { get; set; }

Property Value

List<DiscoveredAssetEvent>

HardwareRevision

Asset hardware revision number.

[JsonPropertyName("hardwareRevision")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? HardwareRevision { get; set; }

Property Value

string

ManagementGroups

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

[JsonPropertyName("managementGroups")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DiscoveredAssetManagementGroup>? ManagementGroups { get; set; }

Property Value

List<DiscoveredAssetManagementGroup>

Manufacturer

Asset manufacturer.

[JsonPropertyName("manufacturer")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Manufacturer { get; set; }

Property Value

string

ManufacturerUri

Asset manufacturer URI.

[JsonPropertyName("manufacturerUri")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ManufacturerUri { get; set; }

Property Value

string

Model

Asset model.

[JsonPropertyName("model")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Model { get; set; }

Property Value

string

ProductCode

Asset product code.

[JsonPropertyName("productCode")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ProductCode { get; set; }

Property Value

string

SerialNumber

Asset serial number.

[JsonPropertyName("serialNumber")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? SerialNumber { get; set; }

Property Value

string

SoftwareRevision

Asset software revision number.

[JsonPropertyName("softwareRevision")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? SoftwareRevision { get; set; }

Property Value

string

Streams

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

[JsonPropertyName("streams")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DiscoveredAssetStream>? Streams { get; set; }

Property Value

List<DiscoveredAssetStream>