Class Asset

Namespace

Azure.Iot.Operations.Services.AssetAndDeviceRegistry.AdrBaseService

Assembly

Azure.Iot.Operations.Services.dll

public class Asset : IJsonOnDeserialized, IJsonOnSerializing

Inheritance

object

Asset

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.

[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 set by the customer.

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

Property Value

Dictionary<string, string>

Datasets

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

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

Property Value

List<AssetDatasetSchemaElementSchema>

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>

Description

Human-readable description of the asset.

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

Property Value

string

DeviceRef

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

Property Value

AssetDeviceRef

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.

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

Property Value

List<string>

DisplayName

Human-readable display name.

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

Property Value

string

DocumentationUri

Asset documentation reference.

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

Property Value

string

Enabled

Enabled/Disabled status of the asset.

[JsonPropertyName("enabled")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? Enabled { get; set; }

Property Value

bool?

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<AssetEventSchemaElementSchema>? Events { get; set; }

Property Value

List<AssetEventSchemaElementSchema>

ExternalAssetId

Asset ID provided by the customer.

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

Property Value

string

HardwareRevision

Asset hardware revision number.

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

Property Value

string

LastTransitionTime

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

[JsonPropertyName("lastTransitionTime")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public DateTime? LastTransitionTime { get; set; }

Property Value

DateTime?

ManagementGroups

Array of management groups that are part of the asset.

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

Property Value

List<AssetManagementGroupSchemaElementSchema>

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<AssetStreamSchemaElementSchema>? Streams { get; set; }

Property Value

List<AssetStreamSchemaElementSchema>

Uuid

Globally unique, immutable, non-reusable id.

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

Property Value

string

Version

A read-only integer that is incremented each time the resource is modified the cloud.

[JsonPropertyName("version")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ulong? Version { get; set; }

Property Value

ulong?