Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. deviceregistry
  5. AssetEndpointProfile
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.deviceregistry.AssetEndpointProfile

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Asset Endpoint Profile definition.

Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-11-01-preview.

Other available API versions: 2023-11-01-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native deviceregistry [ApiVersion]. See the version guide for details.

Example Usage

Create_AssetEndpointProfile

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var assetEndpointProfile = new AzureNative.DeviceRegistry.AssetEndpointProfile("assetEndpointProfile", new()
    {
        AssetEndpointProfileName = "my-assetendpointprofile",
        Authentication = new AzureNative.DeviceRegistry.Inputs.AuthenticationArgs
        {
            Method = AzureNative.DeviceRegistry.AuthenticationMethod.Anonymous,
        },
        EndpointProfileType = "myEndpointProfileType",
        ExtendedLocation = new AzureNative.DeviceRegistry.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
            Type = "CustomLocation",
        },
        Location = "West Europe",
        ResourceGroupName = "myResourceGroup",
        Tags = 
        {
            { "site", "building-1" },
        },
        TargetAddress = "https://www.example.com/myTargetAddress",
    });

});
Copy
package main

import (
	deviceregistry "github.com/pulumi/pulumi-azure-native-sdk/deviceregistry/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := deviceregistry.NewAssetEndpointProfile(ctx, "assetEndpointProfile", &deviceregistry.AssetEndpointProfileArgs{
			AssetEndpointProfileName: pulumi.String("my-assetendpointprofile"),
			Authentication: &deviceregistry.AuthenticationArgs{
				Method: pulumi.String(deviceregistry.AuthenticationMethodAnonymous),
			},
			EndpointProfileType: pulumi.String("myEndpointProfileType"),
			ExtendedLocation: &deviceregistry.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"),
				Type: pulumi.String("CustomLocation"),
			},
			Location:          pulumi.String("West Europe"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			Tags: pulumi.StringMap{
				"site": pulumi.String("building-1"),
			},
			TargetAddress: pulumi.String("https://www.example.com/myTargetAddress"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.deviceregistry.AssetEndpointProfile;
import com.pulumi.azurenative.deviceregistry.AssetEndpointProfileArgs;
import com.pulumi.azurenative.deviceregistry.inputs.AuthenticationArgs;
import com.pulumi.azurenative.deviceregistry.inputs.ExtendedLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var assetEndpointProfile = new AssetEndpointProfile("assetEndpointProfile", AssetEndpointProfileArgs.builder()
            .assetEndpointProfileName("my-assetendpointprofile")
            .authentication(AuthenticationArgs.builder()
                .method("Anonymous")
                .build())
            .endpointProfileType("myEndpointProfileType")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1")
                .type("CustomLocation")
                .build())
            .location("West Europe")
            .resourceGroupName("myResourceGroup")
            .tags(Map.of("site", "building-1"))
            .targetAddress("https://www.example.com/myTargetAddress")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const assetEndpointProfile = new azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfile", {
    assetEndpointProfileName: "my-assetendpointprofile",
    authentication: {
        method: azure_native.deviceregistry.AuthenticationMethod.Anonymous,
    },
    endpointProfileType: "myEndpointProfileType",
    extendedLocation: {
        name: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
        type: "CustomLocation",
    },
    location: "West Europe",
    resourceGroupName: "myResourceGroup",
    tags: {
        site: "building-1",
    },
    targetAddress: "https://www.example.com/myTargetAddress",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

asset_endpoint_profile = azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfile",
    asset_endpoint_profile_name="my-assetendpointprofile",
    authentication={
        "method": azure_native.deviceregistry.AuthenticationMethod.ANONYMOUS,
    },
    endpoint_profile_type="myEndpointProfileType",
    extended_location={
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
        "type": "CustomLocation",
    },
    location="West Europe",
    resource_group_name="myResourceGroup",
    tags={
        "site": "building-1",
    },
    target_address="https://www.example.com/myTargetAddress")
Copy
resources:
  assetEndpointProfile:
    type: azure-native:deviceregistry:AssetEndpointProfile
    properties:
      assetEndpointProfileName: my-assetendpointprofile
      authentication:
        method: Anonymous
      endpointProfileType: myEndpointProfileType
      extendedLocation:
        name: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1
        type: CustomLocation
      location: West Europe
      resourceGroupName: myResourceGroup
      tags:
        site: building-1
      targetAddress: https://www.example.com/myTargetAddress
Copy

Create_AssetEndpointProfile_With_DiscoveredAepRef

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var assetEndpointProfile = new AzureNative.DeviceRegistry.AssetEndpointProfile("assetEndpointProfile", new()
    {
        AssetEndpointProfileName = "my-assetendpointprofile",
        Authentication = new AzureNative.DeviceRegistry.Inputs.AuthenticationArgs
        {
            Method = AzureNative.DeviceRegistry.AuthenticationMethod.Anonymous,
        },
        DiscoveredAssetEndpointProfileRef = "discoveredAssetEndpointProfile1",
        EndpointProfileType = "myEndpointProfileType",
        ExtendedLocation = new AzureNative.DeviceRegistry.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
            Type = "CustomLocation",
        },
        Location = "West Europe",
        ResourceGroupName = "myResourceGroup",
        Tags = 
        {
            { "site", "building-1" },
        },
        TargetAddress = "https://www.example.com/myTargetAddress",
    });

});
Copy
package main

import (
	deviceregistry "github.com/pulumi/pulumi-azure-native-sdk/deviceregistry/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := deviceregistry.NewAssetEndpointProfile(ctx, "assetEndpointProfile", &deviceregistry.AssetEndpointProfileArgs{
			AssetEndpointProfileName: pulumi.String("my-assetendpointprofile"),
			Authentication: &deviceregistry.AuthenticationArgs{
				Method: pulumi.String(deviceregistry.AuthenticationMethodAnonymous),
			},
			DiscoveredAssetEndpointProfileRef: pulumi.String("discoveredAssetEndpointProfile1"),
			EndpointProfileType:               pulumi.String("myEndpointProfileType"),
			ExtendedLocation: &deviceregistry.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"),
				Type: pulumi.String("CustomLocation"),
			},
			Location:          pulumi.String("West Europe"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			Tags: pulumi.StringMap{
				"site": pulumi.String("building-1"),
			},
			TargetAddress: pulumi.String("https://www.example.com/myTargetAddress"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.deviceregistry.AssetEndpointProfile;
import com.pulumi.azurenative.deviceregistry.AssetEndpointProfileArgs;
import com.pulumi.azurenative.deviceregistry.inputs.AuthenticationArgs;
import com.pulumi.azurenative.deviceregistry.inputs.ExtendedLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var assetEndpointProfile = new AssetEndpointProfile("assetEndpointProfile", AssetEndpointProfileArgs.builder()
            .assetEndpointProfileName("my-assetendpointprofile")
            .authentication(AuthenticationArgs.builder()
                .method("Anonymous")
                .build())
            .discoveredAssetEndpointProfileRef("discoveredAssetEndpointProfile1")
            .endpointProfileType("myEndpointProfileType")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1")
                .type("CustomLocation")
                .build())
            .location("West Europe")
            .resourceGroupName("myResourceGroup")
            .tags(Map.of("site", "building-1"))
            .targetAddress("https://www.example.com/myTargetAddress")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const assetEndpointProfile = new azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfile", {
    assetEndpointProfileName: "my-assetendpointprofile",
    authentication: {
        method: azure_native.deviceregistry.AuthenticationMethod.Anonymous,
    },
    discoveredAssetEndpointProfileRef: "discoveredAssetEndpointProfile1",
    endpointProfileType: "myEndpointProfileType",
    extendedLocation: {
        name: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
        type: "CustomLocation",
    },
    location: "West Europe",
    resourceGroupName: "myResourceGroup",
    tags: {
        site: "building-1",
    },
    targetAddress: "https://www.example.com/myTargetAddress",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

asset_endpoint_profile = azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfile",
    asset_endpoint_profile_name="my-assetendpointprofile",
    authentication={
        "method": azure_native.deviceregistry.AuthenticationMethod.ANONYMOUS,
    },
    discovered_asset_endpoint_profile_ref="discoveredAssetEndpointProfile1",
    endpoint_profile_type="myEndpointProfileType",
    extended_location={
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
        "type": "CustomLocation",
    },
    location="West Europe",
    resource_group_name="myResourceGroup",
    tags={
        "site": "building-1",
    },
    target_address="https://www.example.com/myTargetAddress")
Copy
resources:
  assetEndpointProfile:
    type: azure-native:deviceregistry:AssetEndpointProfile
    properties:
      assetEndpointProfileName: my-assetendpointprofile
      authentication:
        method: Anonymous
      discoveredAssetEndpointProfileRef: discoveredAssetEndpointProfile1
      endpointProfileType: myEndpointProfileType
      extendedLocation:
        name: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1
        type: CustomLocation
      location: West Europe
      resourceGroupName: myResourceGroup
      tags:
        site: building-1
      targetAddress: https://www.example.com/myTargetAddress
Copy

Create AssetEndpointProfile Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AssetEndpointProfile(name: string, args: AssetEndpointProfileArgs, opts?: CustomResourceOptions);
@overload
def AssetEndpointProfile(resource_name: str,
                         args: AssetEndpointProfileArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def AssetEndpointProfile(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         endpoint_profile_type: Optional[str] = None,
                         extended_location: Optional[ExtendedLocationArgs] = None,
                         resource_group_name: Optional[str] = None,
                         target_address: Optional[str] = None,
                         additional_configuration: Optional[str] = None,
                         asset_endpoint_profile_name: Optional[str] = None,
                         authentication: Optional[AuthenticationArgs] = None,
                         discovered_asset_endpoint_profile_ref: Optional[str] = None,
                         location: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
func NewAssetEndpointProfile(ctx *Context, name string, args AssetEndpointProfileArgs, opts ...ResourceOption) (*AssetEndpointProfile, error)
public AssetEndpointProfile(string name, AssetEndpointProfileArgs args, CustomResourceOptions? opts = null)
public AssetEndpointProfile(String name, AssetEndpointProfileArgs args)
public AssetEndpointProfile(String name, AssetEndpointProfileArgs args, CustomResourceOptions options)

type: azure-native:deviceregistry:AssetEndpointProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AssetEndpointProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AssetEndpointProfileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AssetEndpointProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AssetEndpointProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssetEndpointProfileArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var assetEndpointProfileResource = new AzureNative.DeviceRegistry.AssetEndpointProfile("assetEndpointProfileResource", new()
{
    EndpointProfileType = "string",
    ExtendedLocation = new AzureNative.DeviceRegistry.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    ResourceGroupName = "string",
    TargetAddress = "string",
    AdditionalConfiguration = "string",
    AssetEndpointProfileName = "string",
    Authentication = new AzureNative.DeviceRegistry.Inputs.AuthenticationArgs
    {
        Method = "string",
        UsernamePasswordCredentials = new AzureNative.DeviceRegistry.Inputs.UsernamePasswordCredentialsArgs
        {
            PasswordSecretName = "string",
            UsernameSecretName = "string",
        },
        X509Credentials = new AzureNative.DeviceRegistry.Inputs.X509CredentialsArgs
        {
            CertificateSecretName = "string",
        },
    },
    DiscoveredAssetEndpointProfileRef = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := deviceregistry.NewAssetEndpointProfile(ctx, "assetEndpointProfileResource", &deviceregistry.AssetEndpointProfileArgs{
	EndpointProfileType: pulumi.String("string"),
	ExtendedLocation: &deviceregistry.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	ResourceGroupName:        pulumi.String("string"),
	TargetAddress:            pulumi.String("string"),
	AdditionalConfiguration:  pulumi.String("string"),
	AssetEndpointProfileName: pulumi.String("string"),
	Authentication: &deviceregistry.AuthenticationArgs{
		Method: pulumi.String("string"),
		UsernamePasswordCredentials: &deviceregistry.UsernamePasswordCredentialsArgs{
			PasswordSecretName: pulumi.String("string"),
			UsernameSecretName: pulumi.String("string"),
		},
		X509Credentials: &deviceregistry.X509CredentialsArgs{
			CertificateSecretName: pulumi.String("string"),
		},
	},
	DiscoveredAssetEndpointProfileRef: pulumi.String("string"),
	Location:                          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var assetEndpointProfileResource = new AssetEndpointProfile("assetEndpointProfileResource", AssetEndpointProfileArgs.builder()
    .endpointProfileType("string")
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .resourceGroupName("string")
    .targetAddress("string")
    .additionalConfiguration("string")
    .assetEndpointProfileName("string")
    .authentication(AuthenticationArgs.builder()
        .method("string")
        .usernamePasswordCredentials(UsernamePasswordCredentialsArgs.builder()
            .passwordSecretName("string")
            .usernameSecretName("string")
            .build())
        .x509Credentials(X509CredentialsArgs.builder()
            .certificateSecretName("string")
            .build())
        .build())
    .discoveredAssetEndpointProfileRef("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
asset_endpoint_profile_resource = azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfileResource",
    endpoint_profile_type="string",
    extended_location={
        "name": "string",
        "type": "string",
    },
    resource_group_name="string",
    target_address="string",
    additional_configuration="string",
    asset_endpoint_profile_name="string",
    authentication={
        "method": "string",
        "username_password_credentials": {
            "password_secret_name": "string",
            "username_secret_name": "string",
        },
        "x509_credentials": {
            "certificate_secret_name": "string",
        },
    },
    discovered_asset_endpoint_profile_ref="string",
    location="string",
    tags={
        "string": "string",
    })
Copy
const assetEndpointProfileResource = new azure_native.deviceregistry.AssetEndpointProfile("assetEndpointProfileResource", {
    endpointProfileType: "string",
    extendedLocation: {
        name: "string",
        type: "string",
    },
    resourceGroupName: "string",
    targetAddress: "string",
    additionalConfiguration: "string",
    assetEndpointProfileName: "string",
    authentication: {
        method: "string",
        usernamePasswordCredentials: {
            passwordSecretName: "string",
            usernameSecretName: "string",
        },
        x509Credentials: {
            certificateSecretName: "string",
        },
    },
    discoveredAssetEndpointProfileRef: "string",
    location: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:deviceregistry:AssetEndpointProfile
properties:
    additionalConfiguration: string
    assetEndpointProfileName: string
    authentication:
        method: string
        usernamePasswordCredentials:
            passwordSecretName: string
            usernameSecretName: string
        x509Credentials:
            certificateSecretName: string
    discoveredAssetEndpointProfileRef: string
    endpointProfileType: string
    extendedLocation:
        name: string
        type: string
    location: string
    resourceGroupName: string
    tags:
        string: string
    targetAddress: string
Copy

AssetEndpointProfile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AssetEndpointProfile resource accepts the following input properties:

EndpointProfileType This property is required. string
Defines the configuration for the connector type that is being used with the endpoint profile.
ExtendedLocation
This property is required.
Changes to this property will trigger replacement.
Pulumi.AzureNative.DeviceRegistry.Inputs.ExtendedLocation
The extended location.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TargetAddress This property is required. string
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.
AdditionalConfiguration string
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
AssetEndpointProfileName Changes to this property will trigger replacement. string
Asset Endpoint Profile name parameter.
Authentication Pulumi.AzureNative.DeviceRegistry.Inputs.Authentication
Defines the client authentication mechanism to the server.
DiscoveredAssetEndpointProfileRef Changes to this property will trigger replacement. string
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.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
EndpointProfileType This property is required. string
Defines the configuration for the connector type that is being used with the endpoint profile.
ExtendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocationArgs
The extended location.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TargetAddress This property is required. string
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.
AdditionalConfiguration string
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
AssetEndpointProfileName Changes to this property will trigger replacement. string
Asset Endpoint Profile name parameter.
Authentication AuthenticationArgs
Defines the client authentication mechanism to the server.
DiscoveredAssetEndpointProfileRef Changes to this property will trigger replacement. string
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.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
endpointProfileType This property is required. String
Defines the configuration for the connector type that is being used with the endpoint profile.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocation
The extended location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
targetAddress This property is required. String
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.
additionalConfiguration String
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
assetEndpointProfileName Changes to this property will trigger replacement. String
Asset Endpoint Profile name parameter.
authentication Authentication
Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef Changes to this property will trigger replacement. String
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.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
endpointProfileType This property is required. string
Defines the configuration for the connector type that is being used with the endpoint profile.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocation
The extended location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
targetAddress This property is required. string
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.
additionalConfiguration string
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
assetEndpointProfileName Changes to this property will trigger replacement. string
Asset Endpoint Profile name parameter.
authentication Authentication
Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef Changes to this property will trigger replacement. string
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.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
endpoint_profile_type This property is required. str
Defines the configuration for the connector type that is being used with the endpoint profile.
extended_location
This property is required.
Changes to this property will trigger replacement.
ExtendedLocationArgs
The extended location.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
target_address This property is required. str
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.
additional_configuration str
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
asset_endpoint_profile_name Changes to this property will trigger replacement. str
Asset Endpoint Profile name parameter.
authentication AuthenticationArgs
Defines the client authentication mechanism to the server.
discovered_asset_endpoint_profile_ref Changes to this property will trigger replacement. str
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.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
endpointProfileType This property is required. String
Defines the configuration for the connector type that is being used with the endpoint profile.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
Property Map
The extended location.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
targetAddress This property is required. String
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.
additionalConfiguration String
Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
assetEndpointProfileName Changes to this property will trigger replacement. String
Asset Endpoint Profile name parameter.
authentication Property Map
Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef Changes to this property will trigger replacement. String
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.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the AssetEndpointProfile resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource.
Status Pulumi.AzureNative.DeviceRegistry.Outputs.AssetEndpointProfileStatusResponse
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
SystemData Pulumi.AzureNative.DeviceRegistry.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uuid string
Globally unique, immutable, non-reusable id.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource.
Status AssetEndpointProfileStatusResponse
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uuid string
Globally unique, immutable, non-reusable id.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the resource.
status AssetEndpointProfileStatusResponse
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid String
Globally unique, immutable, non-reusable id.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Provisioning state of the resource.
status AssetEndpointProfileStatusResponse
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid string
Globally unique, immutable, non-reusable id.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Provisioning state of the resource.
status AssetEndpointProfileStatusResponse
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid str
Globally unique, immutable, non-reusable id.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the resource.
status Property Map
Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uuid String
Globally unique, immutable, non-reusable id.

Supporting Types

AssetEndpointProfileStatusErrorResponse
, AssetEndpointProfileStatusErrorResponseArgs

Code This property is required. int
Error code for classification of errors (ex: 400, 404, 500, etc.).
Message This property is required. string
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
Code This property is required. int
Error code for classification of errors (ex: 400, 404, 500, etc.).
Message This property is required. string
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
code This property is required. Integer
Error code for classification of errors (ex: 400, 404, 500, etc.).
message This property is required. String
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
code This property is required. number
Error code for classification of errors (ex: 400, 404, 500, etc.).
message This property is required. string
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
code This property is required. int
Error code for classification of errors (ex: 400, 404, 500, etc.).
message This property is required. str
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
code This property is required. Number
Error code for classification of errors (ex: 400, 404, 500, etc.).
message This property is required. String
Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).

AssetEndpointProfileStatusResponse
, AssetEndpointProfileStatusResponseArgs

Errors This property is required. List<Pulumi.AzureNative.DeviceRegistry.Inputs.AssetEndpointProfileStatusErrorResponse>
Array object to transfer and persist errors that originate from the Edge.
Errors This property is required. []AssetEndpointProfileStatusErrorResponse
Array object to transfer and persist errors that originate from the Edge.
errors This property is required. List<AssetEndpointProfileStatusErrorResponse>
Array object to transfer and persist errors that originate from the Edge.
errors This property is required. AssetEndpointProfileStatusErrorResponse[]
Array object to transfer and persist errors that originate from the Edge.
errors This property is required. Sequence[AssetEndpointProfileStatusErrorResponse]
Array object to transfer and persist errors that originate from the Edge.
errors This property is required. List<Property Map>
Array object to transfer and persist errors that originate from the Edge.

Authentication
, AuthenticationArgs

Method This property is required. string | Pulumi.AzureNative.DeviceRegistry.AuthenticationMethod
Defines the method to authenticate the user of the client at the server.
UsernamePasswordCredentials Pulumi.AzureNative.DeviceRegistry.Inputs.UsernamePasswordCredentials
Defines the username and password references when UsernamePassword user authentication mode is selected.
X509Credentials Pulumi.AzureNative.DeviceRegistry.Inputs.X509Credentials
Defines the certificate reference when Certificate user authentication mode is selected.
Method This property is required. string | AuthenticationMethod
Defines the method to authenticate the user of the client at the server.
UsernamePasswordCredentials UsernamePasswordCredentials
Defines the username and password references when UsernamePassword user authentication mode is selected.
X509Credentials X509Credentials
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. String | AuthenticationMethod
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials UsernamePasswordCredentials
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials X509Credentials
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. string | AuthenticationMethod
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials UsernamePasswordCredentials
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials X509Credentials
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. str | AuthenticationMethod
Defines the method to authenticate the user of the client at the server.
username_password_credentials UsernamePasswordCredentials
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509_credentials X509Credentials
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. String | "Anonymous" | "Certificate" | "UsernamePassword"
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials Property Map
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials Property Map
Defines the certificate reference when Certificate user authentication mode is selected.

AuthenticationMethod
, AuthenticationMethodArgs

Anonymous
AnonymousThe user authentication method is anonymous.
Certificate
CertificateThe user authentication method is an x509 certificate.
UsernamePassword
UsernamePasswordThe user authentication method is a username and password.
AuthenticationMethodAnonymous
AnonymousThe user authentication method is anonymous.
AuthenticationMethodCertificate
CertificateThe user authentication method is an x509 certificate.
AuthenticationMethodUsernamePassword
UsernamePasswordThe user authentication method is a username and password.
Anonymous
AnonymousThe user authentication method is anonymous.
Certificate
CertificateThe user authentication method is an x509 certificate.
UsernamePassword
UsernamePasswordThe user authentication method is a username and password.
Anonymous
AnonymousThe user authentication method is anonymous.
Certificate
CertificateThe user authentication method is an x509 certificate.
UsernamePassword
UsernamePasswordThe user authentication method is a username and password.
ANONYMOUS
AnonymousThe user authentication method is anonymous.
CERTIFICATE
CertificateThe user authentication method is an x509 certificate.
USERNAME_PASSWORD
UsernamePasswordThe user authentication method is a username and password.
"Anonymous"
AnonymousThe user authentication method is anonymous.
"Certificate"
CertificateThe user authentication method is an x509 certificate.
"UsernamePassword"
UsernamePasswordThe user authentication method is a username and password.

AuthenticationResponse
, AuthenticationResponseArgs

Method This property is required. string
Defines the method to authenticate the user of the client at the server.
UsernamePasswordCredentials Pulumi.AzureNative.DeviceRegistry.Inputs.UsernamePasswordCredentialsResponse
Defines the username and password references when UsernamePassword user authentication mode is selected.
X509Credentials Pulumi.AzureNative.DeviceRegistry.Inputs.X509CredentialsResponse
Defines the certificate reference when Certificate user authentication mode is selected.
Method This property is required. string
Defines the method to authenticate the user of the client at the server.
UsernamePasswordCredentials UsernamePasswordCredentialsResponse
Defines the username and password references when UsernamePassword user authentication mode is selected.
X509Credentials X509CredentialsResponse
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. String
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials UsernamePasswordCredentialsResponse
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials X509CredentialsResponse
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. string
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials UsernamePasswordCredentialsResponse
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials X509CredentialsResponse
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. str
Defines the method to authenticate the user of the client at the server.
username_password_credentials UsernamePasswordCredentialsResponse
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509_credentials X509CredentialsResponse
Defines the certificate reference when Certificate user authentication mode is selected.
method This property is required. String
Defines the method to authenticate the user of the client at the server.
usernamePasswordCredentials Property Map
Defines the username and password references when UsernamePassword user authentication mode is selected.
x509Credentials Property Map
Defines the certificate reference when Certificate user authentication mode is selected.

ExtendedLocation
, ExtendedLocationArgs

Name This property is required. string
The extended location name.
Type This property is required. string
The extended location type.
Name This property is required. string
The extended location name.
Type This property is required. string
The extended location type.
name This property is required. String
The extended location name.
type This property is required. String
The extended location type.
name This property is required. string
The extended location name.
type This property is required. string
The extended location type.
name This property is required. str
The extended location name.
type This property is required. str
The extended location type.
name This property is required. String
The extended location name.
type This property is required. String
The extended location type.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

Name This property is required. string
The extended location name.
Type This property is required. string
The extended location type.
Name This property is required. string
The extended location name.
Type This property is required. string
The extended location type.
name This property is required. String
The extended location name.
type This property is required. String
The extended location type.
name This property is required. string
The extended location name.
type This property is required. string
The extended location type.
name This property is required. str
The extended location name.
type This property is required. str
The extended location type.
name This property is required. String
The extended location name.
type This property is required. String
The extended location type.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UsernamePasswordCredentials
, UsernamePasswordCredentialsArgs

PasswordSecretName This property is required. string
The name of the secret containing the password.
UsernameSecretName This property is required. string
The name of the secret containing the username.
PasswordSecretName This property is required. string
The name of the secret containing the password.
UsernameSecretName This property is required. string
The name of the secret containing the username.
passwordSecretName This property is required. String
The name of the secret containing the password.
usernameSecretName This property is required. String
The name of the secret containing the username.
passwordSecretName This property is required. string
The name of the secret containing the password.
usernameSecretName This property is required. string
The name of the secret containing the username.
password_secret_name This property is required. str
The name of the secret containing the password.
username_secret_name This property is required. str
The name of the secret containing the username.
passwordSecretName This property is required. String
The name of the secret containing the password.
usernameSecretName This property is required. String
The name of the secret containing the username.

UsernamePasswordCredentialsResponse
, UsernamePasswordCredentialsResponseArgs

PasswordSecretName This property is required. string
The name of the secret containing the password.
UsernameSecretName This property is required. string
The name of the secret containing the username.
PasswordSecretName This property is required. string
The name of the secret containing the password.
UsernameSecretName This property is required. string
The name of the secret containing the username.
passwordSecretName This property is required. String
The name of the secret containing the password.
usernameSecretName This property is required. String
The name of the secret containing the username.
passwordSecretName This property is required. string
The name of the secret containing the password.
usernameSecretName This property is required. string
The name of the secret containing the username.
password_secret_name This property is required. str
The name of the secret containing the password.
username_secret_name This property is required. str
The name of the secret containing the username.
passwordSecretName This property is required. String
The name of the secret containing the password.
usernameSecretName This property is required. String
The name of the secret containing the username.

X509Credentials
, X509CredentialsArgs

CertificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
CertificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. String
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificate_secret_name This property is required. str
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. String
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).

X509CredentialsResponse
, X509CredentialsResponseArgs

CertificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
CertificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. String
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. string
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificate_secret_name This property is required. str
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
certificateSecretName This property is required. String
The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:deviceregistry:AssetEndpointProfile my-assetendpointprofile /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native