DeviceRegistryAssetData Class

Definition

A class representing the DeviceRegistryAsset data model. Asset definition.

public class DeviceRegistryAssetData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DeviceRegistry.DeviceRegistryAssetData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DeviceRegistry.DeviceRegistryAssetData>
type DeviceRegistryAssetData = class
    inherit TrackedResourceData
    interface IJsonModel<DeviceRegistryAssetData>
    interface IPersistableModel<DeviceRegistryAssetData>
Public Class DeviceRegistryAssetData
Inherits TrackedResourceData
Implements IJsonModel(Of DeviceRegistryAssetData), IPersistableModel(Of DeviceRegistryAssetData)
Inheritance
DeviceRegistryAssetData
Implements

Constructors

DeviceRegistryAssetData(AzureLocation, DeviceRegistryExtendedLocation)

Initializes a new instance of DeviceRegistryAssetData.

Properties

AssetEndpointProfileUri

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.name>.

AssetType

Resource path to asset type (model) definition.

Attributes

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

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

DataPoints

Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.

DefaultDataPointsConfiguration

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

DefaultEventsConfiguration

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

Description

Human-readable description of the asset.

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 reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.

ExtendedLocation

The extended location.

ExternalAssetId

Asset id provided by the customer.

HardwareRevision

Revision number of the hardware.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
Manufacturer

Asset manufacturer name.

ManufacturerUri

Asset manufacturer URI.

Model

Asset model name.

Name

The name of the resource.

(Inherited from ResourceData)
ProductCode

Asset product code.

ProvisioningState

Provisioning state of the resource.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
Uuid

Globally unique, immutable, non-reusable id.

Version

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<DeviceRegistryAssetData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DeviceRegistryAssetData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DeviceRegistryAssetData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DeviceRegistryAssetData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DeviceRegistryAssetData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to