pulumi-azure-native-kotlin/com.pulumi.azurenative.deviceregistry.kotlin/AssetEndpointProfile

AssetEndpointProfile

class AssetEndpointProfile : KotlinCustomResource

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/#accessing-any-api-version-via-local-packages 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",
    });
});
Content copied to clipboard
package main
import (
	deviceregistry "github.com/pulumi/pulumi-azure-native-sdk/deviceregistry/v2"
	"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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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",
    });
});
Content copied to clipboard
package main
import (
	deviceregistry "github.com/pulumi/pulumi-azure-native-sdk/deviceregistry/v2"
	"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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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}
Content copied to clipboard

Properties

Link copied to clipboard
val additionalConfiguration: Output<String>?

Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).

Link copied to clipboard
val authentication: Output<AuthenticationResponse>?

Defines the client authentication mechanism to the server.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val discoveredAssetEndpointProfileRef: Output<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.

Link copied to clipboard
val endpointProfileType: Output<String>

Defines the configuration for the connector type that is being used with the endpoint profile.

Link copied to clipboard
val extendedLocation: Output<ExtendedLocationResponse>

The extended location.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val provisioningState: Output<String>

Provisioning state of the resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val status: Output<AssetEndpointProfileStatusResponse>

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.

Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val targetAddress: Output<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.

Link copied to clipboard
val type: Output<String>

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

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val uuid: Output<String>

Globally unique, immutable, non-reusable id.