Microsoft.DeviceRegistry discoveredAssets

Bicep resource definition

The discoveredAssets resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceRegistry/discoveredAssets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DeviceRegistry/discoveredAssets@2024-09-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    assetEndpointProfileRef: 'string'
    datasets: [
      {
        dataPoints: [
          {
            dataPointConfiguration: 'string'
            dataSource: 'string'
            lastUpdatedOn: 'string'
            name: 'string'
          }
        ]
        datasetConfiguration: 'string'
        name: 'string'
        topic: {
          path: 'string'
          retain: 'string'
        }
      }
    ]
    defaultDatasetsConfiguration: 'string'
    defaultEventsConfiguration: 'string'
    defaultTopic: {
      path: 'string'
      retain: 'string'
    }
    discoveryId: 'string'
    documentationUri: 'string'
    events: [
      {
        eventConfiguration: 'string'
        eventNotifier: 'string'
        lastUpdatedOn: 'string'
        name: 'string'
        topic: {
          path: 'string'
          retain: 'string'
        }
      }
    ]
    hardwareRevision: 'string'
    manufacturer: 'string'
    manufacturerUri: 'string'
    model: 'string'
    productCode: 'string'
    serialNumber: 'string'
    softwareRevision: 'string'
    version: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DeviceRegistry/discoveredAssets

Name	Description	Value
extendedLocation	The extended location.	ExtendedLocation (required)
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z0-9][a-z0-9-]*[a-z0-9]$` (required)
properties	The resource-specific properties for this resource.	DiscoveredAssetProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

DiscoveredAssetProperties

Name	Description	Value
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 provide asset endpoint profile name.	string (required)
datasets	Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set.	DiscoveredDataset[]
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.	string
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.	string
defaultTopic	Object that describes the default topic information for the asset.	Topic
discoveryId	Identifier used to detect changes in the asset.	string (required)
documentationUri	Reference to the documentation.	string
events	Array of events that are part of the asset. Each event can have per-event configuration.	DiscoveredEvent[]
hardwareRevision	Revision number of the hardware.	string
manufacturer	Asset manufacturer name.	string
manufacturerUri	Asset manufacturer URI.	string
model	Asset model name.	string
productCode	Asset product code.	string
serialNumber	Asset serial number.	string
softwareRevision	Revision number of the software.	string
version	An integer that is incremented each time the resource is modified.	int (required)

DiscoveredDataPoint

Name	Description	Value
dataPointConfiguration	Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
dataSource	The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the data point was added or modified.	string
name	The name of the data point.	string (required)

DiscoveredDataset

Name	Description	Value
dataPoints	Array of data points that are part of the dataset. Each data point can have per-data point configuration.	DiscoveredDataPoint[]
datasetConfiguration	Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset.	string
name	Name of the dataset.	string (required)
topic	Object that describes the topic information for the specific dataset.	Topic

DiscoveredEvent

Name	Description	Value
eventConfiguration	Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
eventNotifier	The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the event was added or modified.	string
name	The name of the event.	string (required)
topic	Object that describes the topic information for the specific event.	Topic

ExtendedLocation

Name	Description	Value
name	The extended location name.	string (required)
type	The extended location type.	string (required)

Topic

Name	Description	Value
path	The topic path for messages published to an MQTT broker.	string (required)
retain	When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'.	'Keep' 'Never'

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The discoveredAssets resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Resource format

To create a Microsoft.DeviceRegistry/discoveredAssets resource, add the following JSON to your template.

{
  "type": "Microsoft.DeviceRegistry/discoveredAssets",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "assetEndpointProfileRef": "string",
    "datasets": [
      {
        "dataPoints": [
          {
            "dataPointConfiguration": "string",
            "dataSource": "string",
            "lastUpdatedOn": "string",
            "name": "string"
          }
        ],
        "datasetConfiguration": "string",
        "name": "string",
        "topic": {
          "path": "string",
          "retain": "string"
        }
      }
    ],
    "defaultDatasetsConfiguration": "string",
    "defaultEventsConfiguration": "string",
    "defaultTopic": {
      "path": "string",
      "retain": "string"
    },
    "discoveryId": "string",
    "documentationUri": "string",
    "events": [
      {
        "eventConfiguration": "string",
        "eventNotifier": "string",
        "lastUpdatedOn": "string",
        "name": "string",
        "topic": {
          "path": "string",
          "retain": "string"
        }
      }
    ],
    "hardwareRevision": "string",
    "manufacturer": "string",
    "manufacturerUri": "string",
    "model": "string",
    "productCode": "string",
    "serialNumber": "string",
    "softwareRevision": "string",
    "version": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DeviceRegistry/discoveredAssets

Name	Description	Value
apiVersion	The api version	'2024-09-01-preview'
extendedLocation	The extended location.	ExtendedLocation (required)
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z0-9][a-z0-9-]*[a-z0-9]$` (required)
properties	The resource-specific properties for this resource.	DiscoveredAssetProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DeviceRegistry/discoveredAssets'

DiscoveredAssetProperties

Name	Description	Value
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 provide asset endpoint profile name.	string (required)
datasets	Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set.	DiscoveredDataset[]
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.	string
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.	string
defaultTopic	Object that describes the default topic information for the asset.	Topic
discoveryId	Identifier used to detect changes in the asset.	string (required)
documentationUri	Reference to the documentation.	string
events	Array of events that are part of the asset. Each event can have per-event configuration.	DiscoveredEvent[]
hardwareRevision	Revision number of the hardware.	string
manufacturer	Asset manufacturer name.	string
manufacturerUri	Asset manufacturer URI.	string
model	Asset model name.	string
productCode	Asset product code.	string
serialNumber	Asset serial number.	string
softwareRevision	Revision number of the software.	string
version	An integer that is incremented each time the resource is modified.	int (required)

DiscoveredDataPoint

Name	Description	Value
dataPointConfiguration	Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
dataSource	The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the data point was added or modified.	string
name	The name of the data point.	string (required)

DiscoveredDataset

Name	Description	Value
dataPoints	Array of data points that are part of the dataset. Each data point can have per-data point configuration.	DiscoveredDataPoint[]
datasetConfiguration	Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset.	string
name	Name of the dataset.	string (required)
topic	Object that describes the topic information for the specific dataset.	Topic

DiscoveredEvent

Name	Description	Value
eventConfiguration	Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
eventNotifier	The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the event was added or modified.	string
name	The name of the event.	string (required)
topic	Object that describes the topic information for the specific event.	Topic

ExtendedLocation

Name	Description	Value
name	The extended location name.	string (required)
type	The extended location type.	string (required)

Topic

Name	Description	Value
path	The topic path for messages published to an MQTT broker.	string (required)
retain	When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'.	'Keep' 'Never'

TrackedResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

The discoveredAssets resource type can be deployed with operations that target:

Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeviceRegistry/discoveredAssets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/discoveredAssets@2024-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      assetEndpointProfileRef = "string"
      datasets = [
        {
          dataPoints = [
            {
              dataPointConfiguration = "string"
              dataSource = "string"
              lastUpdatedOn = "string"
              name = "string"
            }
          ]
          datasetConfiguration = "string"
          name = "string"
          topic = {
            path = "string"
            retain = "string"
          }
        }
      ]
      defaultDatasetsConfiguration = "string"
      defaultEventsConfiguration = "string"
      defaultTopic = {
        path = "string"
        retain = "string"
      }
      discoveryId = "string"
      documentationUri = "string"
      events = [
        {
          eventConfiguration = "string"
          eventNotifier = "string"
          lastUpdatedOn = "string"
          name = "string"
          topic = {
            path = "string"
            retain = "string"
          }
        }
      ]
      hardwareRevision = "string"
      manufacturer = "string"
      manufacturerUri = "string"
      model = "string"
      productCode = "string"
      serialNumber = "string"
      softwareRevision = "string"
      version = int
    }
  }
}

Property Values

Microsoft.DeviceRegistry/discoveredAssets

Name	Description	Value
extendedLocation	The extended location.	ExtendedLocation (required)
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z0-9][a-z0-9-]*[a-z0-9]$` (required)
properties	The resource-specific properties for this resource.	DiscoveredAssetProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DeviceRegistry/discoveredAssets@2024-09-01-preview"

DiscoveredAssetProperties

Name	Description	Value
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 provide asset endpoint profile name.	string (required)
datasets	Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set.	DiscoveredDataset[]
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.	string
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.	string
defaultTopic	Object that describes the default topic information for the asset.	Topic
discoveryId	Identifier used to detect changes in the asset.	string (required)
documentationUri	Reference to the documentation.	string
events	Array of events that are part of the asset. Each event can have per-event configuration.	DiscoveredEvent[]
hardwareRevision	Revision number of the hardware.	string
manufacturer	Asset manufacturer name.	string
manufacturerUri	Asset manufacturer URI.	string
model	Asset model name.	string
productCode	Asset product code.	string
serialNumber	Asset serial number.	string
softwareRevision	Revision number of the software.	string
version	An integer that is incremented each time the resource is modified.	int (required)

DiscoveredDataPoint

Name	Description	Value
dataPointConfiguration	Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
dataSource	The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the data point was added or modified.	string
name	The name of the data point.	string (required)

DiscoveredDataset

Name	Description	Value
dataPoints	Array of data points that are part of the dataset. Each data point can have per-data point configuration.	DiscoveredDataPoint[]
datasetConfiguration	Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset.	string
name	Name of the dataset.	string (required)
topic	Object that describes the topic information for the specific dataset.	Topic

DiscoveredEvent

Name	Description	Value
eventConfiguration	Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.	string
eventNotifier	The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.	string (required)
lastUpdatedOn	UTC timestamp indicating when the event was added or modified.	string
name	The name of the event.	string (required)
topic	Object that describes the topic information for the specific event.	Topic

ExtendedLocation

Name	Description	Value
name	The extended location name.	string (required)
type	The extended location type.	string (required)

Topic

Name	Description	Value
path	The topic path for messages published to an MQTT broker.	string (required)
retain	When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'.	'Keep' 'Never'

TrackedResourceTags

Name	Description	Value

Feedback

Was this page helpful?

Last updated on 2024-12-09

Microsoft.DeviceRegistry discoveredAssets

Bicep resource definition

Resource format

Property Values

Microsoft.DeviceRegistry/discoveredAssets

DiscoveredAssetProperties

DiscoveredDataPoint

DiscoveredDataset

DiscoveredEvent

ExtendedLocation

Topic

TrackedResourceTags

ARM template resource definition

Usage Examples

Resource format

Property Values

Microsoft.DeviceRegistry/discoveredAssets

DiscoveredAssetProperties

DiscoveredDataPoint

DiscoveredDataset

DiscoveredEvent

ExtendedLocation

Topic

TrackedResourceTags

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.DeviceRegistry/discoveredAssets

DiscoveredAssetProperties

DiscoveredDataPoint

DiscoveredDataset

DiscoveredEvent

ExtendedLocation

Topic

TrackedResourceTags

Feedback

Additional resources