azure-native.deviceregistry.AssetEndpointProfile
Explore with Pulumi AI
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",
});
});
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
})
}
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());
}
}
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",
});
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")
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
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",
});
});
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
})
}
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());
}
}
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",
});
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")
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
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 string
- The unique name of the resource.
- args AssetEndpointProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args AssetEndpointProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AssetEndpointProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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" },
},
});
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"),
},
})
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());
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",
})
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",
},
});
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
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:
- Endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- Extended
Location Pulumi.Azure Native. Device Registry. Inputs. Extended Location - The extended location.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Target
Address 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.
- Additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- Asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- Authentication
Pulumi.
Azure Native. Device Registry. Inputs. Authentication - Defines the client authentication mechanism to the server.
- Discovered
Asset stringEndpoint Profile Ref - 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 string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- Extended
Location ExtendedLocation Args - The extended location.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Target
Address 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.
- Additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- Asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- Authentication
Authentication
Args - Defines the client authentication mechanism to the server.
- Discovered
Asset stringEndpoint Profile Ref - 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 string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- endpoint
Profile StringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location ExtendedLocation - The extended location.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- target
Address 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.
- additional
Configuration String - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- asset
Endpoint StringProfile Name - Asset Endpoint Profile name parameter.
- authentication Authentication
- Defines the client authentication mechanism to the server.
- discovered
Asset StringEndpoint Profile Ref - 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 String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location ExtendedLocation - The extended location.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- target
Address 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.
- additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- authentication Authentication
- Defines the client authentication mechanism to the server.
- discovered
Asset stringEndpoint Profile Ref - 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 string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- endpoint_
profile_ strtype - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended_
location ExtendedLocation Args - The extended location.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- target_
address 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_ strprofile_ name - Asset Endpoint Profile name parameter.
- authentication
Authentication
Args - Defines the client authentication mechanism to the server.
- discovered_
asset_ strendpoint_ profile_ ref - 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 str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- endpoint
Profile StringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location Property Map - The extended location.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- target
Address 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.
- additional
Configuration String - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- asset
Endpoint StringProfile Name - Asset Endpoint Profile name parameter.
- authentication Property Map
- Defines the client authentication mechanism to the server.
- discovered
Asset StringEndpoint Profile Ref - 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 String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the AssetEndpointProfile resource produces the following output properties:
- Azure
Api stringVersion - 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
- Provisioning
State string - Provisioning state of the resource.
- Status
Pulumi.
Azure Native. Device Registry. Outputs. Asset Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- System
Data Pulumi.Azure Native. Device Registry. Outputs. System Data Response - 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 stringVersion - 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
- Provisioning
State string - Provisioning state of the resource.
- Status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- System
Data SystemData Response - 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 StringVersion - 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
- provisioning
State String - Provisioning state of the resource.
- status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system
Data SystemData Response - 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 stringVersion - 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
- provisioning
State string - Provisioning state of the resource.
- status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system
Data SystemData Response - 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_ strversion - 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
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system_
data SystemData Response - 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.
- azure
Api StringVersion - 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
- provisioning
State 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.
- system
Data 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
AssetEndpointProfileStatusResponse, AssetEndpointProfileStatusResponseArgs
- Errors
List<Pulumi.
Azure Native. Device Registry. Inputs. Asset Endpoint Profile Status Error Response> - Array object to transfer and persist errors that originate from the Edge.
- Errors
[]Asset
Endpoint Profile Status Error Response - Array object to transfer and persist errors that originate from the Edge.
- errors
List<Asset
Endpoint Profile Status Error Response> - Array object to transfer and persist errors that originate from the Edge.
- errors
Asset
Endpoint Profile Status Error Response[] - Array object to transfer and persist errors that originate from the Edge.
- errors
Sequence[Asset
Endpoint Profile Status Error Response] - Array object to transfer and persist errors that originate from the Edge.
- errors List<Property Map>
- Array object to transfer and persist errors that originate from the Edge.
Authentication, AuthenticationArgs
- Method
string | Pulumi.
Azure Native. Device Registry. Authentication Method - Defines the method to authenticate the user of the client at the server.
- Username
Password Pulumi.Credentials Azure Native. Device Registry. Inputs. Username Password Credentials - Defines the username and password references when UsernamePassword user authentication mode is selected.
- X509Credentials
Pulumi.
Azure Native. Device Registry. Inputs. X509Credentials - Defines the certificate reference when Certificate user authentication mode is selected.
- Method
string | Authentication
Method - Defines the method to authenticate the user of the client at the server.
- Username
Password UsernameCredentials Password Credentials - 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
String | Authentication
Method - Defines the method to authenticate the user of the client at the server.
- username
Password UsernameCredentials Password Credentials - 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
string | Authentication
Method - Defines the method to authenticate the user of the client at the server.
- username
Password UsernameCredentials Password Credentials - 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
str | Authentication
Method - Defines the method to authenticate the user of the client at the server.
- username_
password_ Usernamecredentials Password Credentials - 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
String | "Anonymous" | "Certificate" | "Username
Password" - Defines the method to authenticate the user of the client at the server.
- username
Password Property MapCredentials - 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.
- Username
Password - UsernamePasswordThe user authentication method is a username and password.
- Authentication
Method Anonymous - AnonymousThe user authentication method is anonymous.
- Authentication
Method Certificate - CertificateThe user authentication method is an x509 certificate.
- Authentication
Method 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.
- 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.
- 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.
- 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.
- "Username
Password" - UsernamePasswordThe user authentication method is a username and password.
AuthenticationResponse, AuthenticationResponseArgs
- Method string
- Defines the method to authenticate the user of the client at the server.
- Username
Password Pulumi.Credentials Azure Native. Device Registry. Inputs. Username Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- X509Credentials
Pulumi.
Azure Native. Device Registry. Inputs. X509Credentials Response - Defines the certificate reference when Certificate user authentication mode is selected.
- Method string
- Defines the method to authenticate the user of the client at the server.
- Username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- X509Credentials
X509Credentials
Response - Defines the certificate reference when Certificate user authentication mode is selected.
- method String
- Defines the method to authenticate the user of the client at the server.
- username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- x509Credentials
X509Credentials
Response - Defines the certificate reference when Certificate user authentication mode is selected.
- method string
- Defines the method to authenticate the user of the client at the server.
- username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- x509Credentials
X509Credentials
Response - Defines the certificate reference when Certificate user authentication mode is selected.
- method str
- Defines the method to authenticate the user of the client at the server.
- username_
password_ Usernamecredentials Password Credentials Response - 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 String
- Defines the method to authenticate the user of the client at the server.
- username
Password Property MapCredentials - 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
ExtendedLocationResponse, ExtendedLocationResponseArgs
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UsernamePasswordCredentials, UsernamePasswordCredentialsArgs
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
- password
Secret stringName - The name of the secret containing the password.
- username
Secret stringName - The name of the secret containing the username.
- password_
secret_ strname - The name of the secret containing the password.
- username_
secret_ strname - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
UsernamePasswordCredentialsResponse, UsernamePasswordCredentialsResponseArgs
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
- password
Secret stringName - The name of the secret containing the password.
- username
Secret stringName - The name of the secret containing the username.
- password_
secret_ strname - The name of the secret containing the password.
- username_
secret_ strname - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
X509Credentials, X509CredentialsArgs
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate_
secret_ strname - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
X509CredentialsResponse, X509CredentialsResponseArgs
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate_
secret_ strname - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0