Microsoft.DeviceRegistry assetEndpointProfiles

Bicep resource definition

The assetEndpointProfiles 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/assetEndpointProfiles resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DeviceRegistry/assetEndpointProfiles@2026-11-02-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalConfiguration: 'string'
    authentication: {
      method: 'string'
      usernamePasswordCredentials: {
        passwordSecretName: 'string'
        usernameSecretName: 'string'
      }
      x509Credentials: {
        certificateSecretName: 'string'
      }
    }
    discoveredAssetEndpointProfileRef: 'string'
    endpointProfileType: 'string'
    targetAddress: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DeviceRegistry/assetEndpointProfiles

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. AssetEndpointProfileProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

AssetEndpointProfileProperties

Name Description Value
additionalConfiguration Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). string
authentication Defines the client authentication mechanism to the server. Authentication
discoveredAssetEndpointProfileRef Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided. string
endpointProfileType Defines the configuration for the connector type that is being used with the endpoint profile. string (required)
targetAddress The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. string (required)

Authentication

Name Description Value
method Defines the method to authenticate the user of the client at the server. 'Anonymous'
'Certificate'
'UsernamePassword' (required)
usernamePasswordCredentials Defines the username and password references when UsernamePassword user authentication mode is selected. UsernamePasswordCredentials
x509Credentials Defines the certificate reference when Certificate user authentication mode is selected. X509Credentials

ExtendedLocation

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

TrackedResourceTags

Name Description Value

UsernamePasswordCredentials

Name Description Value
passwordSecretName The name of the secret containing the password. string (required)
usernameSecretName The name of the secret containing the username. string (required)

X509Credentials

Name Description Value
certificateSecretName The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). string (required)

ARM template resource definition

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

Usage Examples

Resource format

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

{
  "type": "Microsoft.DeviceRegistry/assetEndpointProfiles",
  "apiVersion": "2026-11-02-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalConfiguration": "string",
    "authentication": {
      "method": "string",
      "usernamePasswordCredentials": {
        "passwordSecretName": "string",
        "usernameSecretName": "string"
      },
      "x509Credentials": {
        "certificateSecretName": "string"
      }
    },
    "discoveredAssetEndpointProfileRef": "string",
    "endpointProfileType": "string",
    "targetAddress": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DeviceRegistry/assetEndpointProfiles

Name Description Value
apiVersion The api version '2026-11-02-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. AssetEndpointProfileProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DeviceRegistry/assetEndpointProfiles'

AssetEndpointProfileProperties

Name Description Value
additionalConfiguration Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). string
authentication Defines the client authentication mechanism to the server. Authentication
discoveredAssetEndpointProfileRef Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided. string
endpointProfileType Defines the configuration for the connector type that is being used with the endpoint profile. string (required)
targetAddress The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. string (required)

Authentication

Name Description Value
method Defines the method to authenticate the user of the client at the server. 'Anonymous'
'Certificate'
'UsernamePassword' (required)
usernamePasswordCredentials Defines the username and password references when UsernamePassword user authentication mode is selected. UsernamePasswordCredentials
x509Credentials Defines the certificate reference when Certificate user authentication mode is selected. X509Credentials

ExtendedLocation

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

TrackedResourceTags

Name Description Value

UsernamePasswordCredentials

Name Description Value
passwordSecretName The name of the secret containing the password. string (required)
usernameSecretName The name of the secret containing the username. string (required)

X509Credentials

Name Description Value
certificateSecretName The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). string (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/assetEndpointProfiles@2026-11-02-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      additionalConfiguration = "string"
      authentication = {
        method = "string"
        usernamePasswordCredentials = {
          passwordSecretName = "string"
          usernameSecretName = "string"
        }
        x509Credentials = {
          certificateSecretName = "string"
        }
      }
      discoveredAssetEndpointProfileRef = "string"
      endpointProfileType = "string"
      targetAddress = "string"
    }
  }
}

Property Values

Microsoft.DeviceRegistry/assetEndpointProfiles

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. AssetEndpointProfileProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DeviceRegistry/assetEndpointProfiles@2026-11-02-preview"

AssetEndpointProfileProperties

Name Description Value
additionalConfiguration Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). string
authentication Defines the client authentication mechanism to the server. Authentication
discoveredAssetEndpointProfileRef Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided. string
endpointProfileType Defines the configuration for the connector type that is being used with the endpoint profile. string (required)
targetAddress The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. string (required)

Authentication

Name Description Value
method Defines the method to authenticate the user of the client at the server. 'Anonymous'
'Certificate'
'UsernamePassword' (required)
usernamePasswordCredentials Defines the username and password references when UsernamePassword user authentication mode is selected. UsernamePasswordCredentials
x509Credentials Defines the certificate reference when Certificate user authentication mode is selected. X509Credentials

ExtendedLocation

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

TrackedResourceTags

Name Description Value

UsernamePasswordCredentials

Name Description Value
passwordSecretName The name of the secret containing the password. string (required)
usernameSecretName The name of the secret containing the username. string (required)

X509Credentials

Name Description Value
certificateSecretName The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). string (required)
  • Last updated on