Microsoft.DeviceRegistry namespaces/discoveredDevices 2025-07-01-preview

Bicep resource definition

The namespaces/discoveredDevices resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.DeviceRegistry/namespaces/discoveredDevices@2025-07-01-preview' = {
  parent: resourceSymbolicName
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    attributes: {
      {customized property}: any(...)
    }
    discoveryId: 'string'
    endpoints: {
      inbound: {
        {customized property}: {
          additionalConfiguration: 'string'
          address: 'string'
          endpointType: 'string'
          lastUpdatedOn: 'string'
          supportedAuthenticationMethods: [
            'string'
          ]
          version: 'string'
        }
      }
      outbound: {
        assigned: {
          {customized property}: {
            address: 'string'
            endpointType: 'string'
          }
        }
      }
    }
    externalDeviceId: 'string'
    manufacturer: 'string'
    model: 'string'
    operatingSystem: 'string'
    operatingSystemVersion: 'string'
    version: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DeviceRegistry/namespaces/discoveredDevices

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)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: namespaces
properties The resource-specific properties for this resource. NamespaceDiscoveredDeviceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

DeviceMessagingEndpoint

Name Description Value
address The endpoint address to connect to. string (required)
endpointType Type of connection used for the messaging endpoint. string

DiscoveredInboundEndpoints

Name Description Value
additionalConfiguration Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF). string
address The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com). string (required)
endpointType Type of connection endpoint. string (required)
lastUpdatedOn The timestamp (in UTC) when the endpoint was discovered. string
supportedAuthenticationMethods List of supported authentication methods supported by device for Inbound connections. String array containing any of:
'Anonymous'
'Certificate'
'UsernamePassword'
version Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc. string

DiscoveredMessagingEndpoints

Name Description Value
inbound Set of endpoints to connect to the device. DiscoveredMessagingEndpointsInbound
outbound Set of endpoints a device can connect to. DiscoveredOutboundEndpoints

DiscoveredMessagingEndpointsInbound

Name Description Value

DiscoveredOutboundEndpoints

Name Description Value
assigned Endpoints the device can connect to. DiscoveredOutboundEndpointsAssigned (required)

DiscoveredOutboundEndpointsAssigned

Name Description Value

ExtendedLocation

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

NamespaceDiscoveredDeviceProperties

Name Description Value
attributes A set of key-value pairs that contain custom attributes. NamespaceDiscoveredDevicePropertiesAttributes
discoveryId Identifier used to detect changes in the discovered device. string (required)
endpoints Endpoints for discovered devices. DiscoveredMessagingEndpoints
externalDeviceId A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. string
manufacturer Device manufacturer. string
model Device model. string
operatingSystem Device operating system name. string
operatingSystemVersion Device operating system version. string
version An integer that is incremented each time the resource is modified. int (required)

NamespaceDiscoveredDevicePropertiesAttributes

Name Description Value

TrackedResourceTags

Name Description Value

ARM template resource definition

The namespaces/discoveredDevices resource type can be deployed with operations that target:

Usage Examples

Resource format

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

{
  "type": "Microsoft.DeviceRegistry/namespaces/discoveredDevices",
  "apiVersion": "2025-07-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "attributes": {
      "{customized property}": {}
    },
    "discoveryId": "string",
    "endpoints": {
      "inbound": {
        "{customized property}": {
          "additionalConfiguration": "string",
          "address": "string",
          "endpointType": "string",
          "lastUpdatedOn": "string",
          "supportedAuthenticationMethods": [ "string" ],
          "version": "string"
        }
      },
      "outbound": {
        "assigned": {
          "{customized property}": {
            "address": "string",
            "endpointType": "string"
          }
        }
      }
    },
    "externalDeviceId": "string",
    "manufacturer": "string",
    "model": "string",
    "operatingSystem": "string",
    "operatingSystemVersion": "string",
    "version": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DeviceRegistry/namespaces/discoveredDevices

Name Description Value
apiVersion The api version '2025-07-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. NamespaceDiscoveredDeviceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DeviceRegistry/namespaces/discoveredDevices'

DeviceMessagingEndpoint

Name Description Value
address The endpoint address to connect to. string (required)
endpointType Type of connection used for the messaging endpoint. string

DiscoveredInboundEndpoints

Name Description Value
additionalConfiguration Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF). string
address The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com). string (required)
endpointType Type of connection endpoint. string (required)
lastUpdatedOn The timestamp (in UTC) when the endpoint was discovered. string
supportedAuthenticationMethods List of supported authentication methods supported by device for Inbound connections. String array containing any of:
'Anonymous'
'Certificate'
'UsernamePassword'
version Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc. string

DiscoveredMessagingEndpoints

Name Description Value
inbound Set of endpoints to connect to the device. DiscoveredMessagingEndpointsInbound
outbound Set of endpoints a device can connect to. DiscoveredOutboundEndpoints

DiscoveredMessagingEndpointsInbound

Name Description Value

DiscoveredOutboundEndpoints

Name Description Value
assigned Endpoints the device can connect to. DiscoveredOutboundEndpointsAssigned (required)

DiscoveredOutboundEndpointsAssigned

Name Description Value

ExtendedLocation

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

NamespaceDiscoveredDeviceProperties

Name Description Value
attributes A set of key-value pairs that contain custom attributes. NamespaceDiscoveredDevicePropertiesAttributes
discoveryId Identifier used to detect changes in the discovered device. string (required)
endpoints Endpoints for discovered devices. DiscoveredMessagingEndpoints
externalDeviceId A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. string
manufacturer Device manufacturer. string
model Device model. string
operatingSystem Device operating system name. string
operatingSystemVersion Device operating system version. string
version An integer that is incremented each time the resource is modified. int (required)

NamespaceDiscoveredDevicePropertiesAttributes

Name Description Value

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The namespaces/discoveredDevices 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/namespaces/discoveredDevices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/namespaces/discoveredDevices@2025-07-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      attributes = {
        {customized property} = ?
      }
      discoveryId = "string"
      endpoints = {
        inbound = {
          {customized property} = {
            additionalConfiguration = "string"
            address = "string"
            endpointType = "string"
            lastUpdatedOn = "string"
            supportedAuthenticationMethods = [
              "string"
            ]
            version = "string"
          }
        }
        outbound = {
          assigned = {
            {customized property} = {
              address = "string"
              endpointType = "string"
            }
          }
        }
      }
      externalDeviceId = "string"
      manufacturer = "string"
      model = "string"
      operatingSystem = "string"
      operatingSystemVersion = "string"
      version = int
    }
  }
}

Property Values

Microsoft.DeviceRegistry/namespaces/discoveredDevices

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)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties The resource-specific properties for this resource. NamespaceDiscoveredDeviceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DeviceRegistry/namespaces/discoveredDevices@2025-07-01-preview"

DeviceMessagingEndpoint

Name Description Value
address The endpoint address to connect to. string (required)
endpointType Type of connection used for the messaging endpoint. string

DiscoveredInboundEndpoints

Name Description Value
additionalConfiguration Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF). string
address The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com). string (required)
endpointType Type of connection endpoint. string (required)
lastUpdatedOn The timestamp (in UTC) when the endpoint was discovered. string
supportedAuthenticationMethods List of supported authentication methods supported by device for Inbound connections. String array containing any of:
'Anonymous'
'Certificate'
'UsernamePassword'
version Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc. string

DiscoveredMessagingEndpoints

Name Description Value
inbound Set of endpoints to connect to the device. DiscoveredMessagingEndpointsInbound
outbound Set of endpoints a device can connect to. DiscoveredOutboundEndpoints

DiscoveredMessagingEndpointsInbound

Name Description Value

DiscoveredOutboundEndpoints

Name Description Value
assigned Endpoints the device can connect to. DiscoveredOutboundEndpointsAssigned (required)

DiscoveredOutboundEndpointsAssigned

Name Description Value

ExtendedLocation

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

NamespaceDiscoveredDeviceProperties

Name Description Value
attributes A set of key-value pairs that contain custom attributes. NamespaceDiscoveredDevicePropertiesAttributes
discoveryId Identifier used to detect changes in the discovered device. string (required)
endpoints Endpoints for discovered devices. DiscoveredMessagingEndpoints
externalDeviceId A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. string
manufacturer Device manufacturer. string
model Device model. string
operatingSystem Device operating system name. string
operatingSystemVersion Device operating system version. string
version An integer that is incremented each time the resource is modified. int (required)

NamespaceDiscoveredDevicePropertiesAttributes

Name Description Value

TrackedResourceTags

Name Description Value