Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. digitaltwins
  5. PrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.digitaltwins.PrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    The private endpoint connection of a Digital Twin. Azure REST API version: 2023-01-31. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2020-12-01.

    Example Usage

    Update the status of a private endpoint connection with the given name

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.DigitalTwins.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "myPrivateConnection",
        Properties = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesArgs
        {
            PrivateLinkServiceConnectionState = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs
            {
                Description = "Approved by johndoe@company.com.",
                Status = AzureNative.DigitalTwins.PrivateLinkServiceConnectionStatus.Approved,
            },
        },
        ResourceGroupName = "resRg",
        ResourceName = "myDigitalTwinsService",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitaltwins.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &digitaltwins.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("myPrivateConnection"),
			Properties: &digitaltwins.ConnectionPropertiesArgs{
				PrivateLinkServiceConnectionState: &digitaltwins.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs{
					Description: pulumi.String("Approved by johndoe@company.com."),
					Status:      pulumi.String(digitaltwins.PrivateLinkServiceConnectionStatusApproved),
				},
			},
			ResourceGroupName: pulumi.String("resRg"),
			ResourceName:      pulumi.String("myDigitalTwinsService"),
		})
		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.digitaltwins.PrivateEndpointConnection;
import com.pulumi.azurenative.digitaltwins.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.digitaltwins.inputs.ConnectionPropertiesArgs;
import com.pulumi.azurenative.digitaltwins.inputs.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs;
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 privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
            .privateEndpointConnectionName("myPrivateConnection")
            .properties(ConnectionPropertiesArgs.builder()
                .privateLinkServiceConnectionState(ConnectionPropertiesPrivateLinkServiceConnectionStateArgs.builder()
                    .description("Approved by johndoe@company.com.")
                    .status("Approved")
                    .build())
                .build())
            .resourceGroupName("resRg")
            .resourceName("myDigitalTwinsService")
            .build());

    }
}

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

const privateEndpointConnection = new azure_native.digitaltwins.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "myPrivateConnection",
    properties: {
        privateLinkServiceConnectionState: {
            description: "Approved by johndoe@company.com.",
            status: azure_native.digitaltwins.PrivateLinkServiceConnectionStatus.Approved,
        },
    },
    resourceGroupName: "resRg",
    resourceName: "myDigitalTwinsService",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.digitaltwins.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="myPrivateConnection",
    properties={
        "private_link_service_connection_state": {
            "description": "Approved by johndoe@company.com.",
            "status": azure_native.digitaltwins.PrivateLinkServiceConnectionStatus.APPROVED,
        },
    },
    resource_group_name="resRg",
    resource_name_="myDigitalTwinsService")

    resources:
  privateEndpointConnection:
    type: azure-native:digitaltwins:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: myPrivateConnection
      properties:
        privateLinkServiceConnectionState:
          description: Approved by johndoe@company.com.
          status: Approved
      resourceGroupName: resRg
      resourceName: myDigitalTwinsService

    Create PrivateEndpointConnection Resource

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

    Constructor syntax

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

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              properties: Optional[ConnectionPropertiesArgs] = None,
                              resource_group_name: Optional[str] = None,
                              resource_name_: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = None)
    func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
    public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)

    type: azure-native:digitaltwins:PrivateEndpointConnection
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 PrivateEndpointConnectionArgs
    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 PrivateEndpointConnectionInitArgs
    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 PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    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 exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new AzureNative.DigitalTwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", new()
{
    Properties = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesArgs
    {
        GroupIds = new[]
        {
            "string",
        },
        PrivateLinkServiceConnectionState = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs
        {
            Description = "string",
            Status = "string",
            ActionsRequired = "string",
        },
    },
    ResourceGroupName = "string",
    ResourceName = "string",
    PrivateEndpointConnectionName = "string",
});

    example, err := digitaltwins.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", &digitaltwins.PrivateEndpointConnectionArgs{
	Properties: &digitaltwins.ConnectionPropertiesArgs{
		GroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrivateLinkServiceConnectionState: &digitaltwins.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs{
			Description:     pulumi.String("string"),
			Status:          pulumi.String("string"),
			ActionsRequired: pulumi.String("string"),
		},
	},
	ResourceGroupName:             pulumi.String("string"),
	ResourceName:                  pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", PrivateEndpointConnectionArgs.builder()
    .properties(ConnectionPropertiesArgs.builder()
        .groupIds("string")
        .privateLinkServiceConnectionState(ConnectionPropertiesPrivateLinkServiceConnectionStateArgs.builder()
            .description("string")
            .status("string")
            .actionsRequired("string")
            .build())
        .build())
    .resourceGroupName("string")
    .resourceName("string")
    .privateEndpointConnectionName("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_digitaltwins = azure_native.digitaltwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins",
    properties={
        "group_ids": ["string"],
        "private_link_service_connection_state": {
            "description": "string",
            "status": "string",
            "actions_required": "string",
        },
    },
    resource_group_name="string",
    resource_name_="string",
    private_endpoint_connection_name="string")

    const exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new azure_native.digitaltwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", {
    properties: {
        groupIds: ["string"],
        privateLinkServiceConnectionState: {
            description: "string",
            status: "string",
            actionsRequired: "string",
        },
    },
    resourceGroupName: "string",
    resourceName: "string",
    privateEndpointConnectionName: "string",
});

    type: azure-native:digitaltwins:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    properties:
        groupIds:
            - string
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
    resourceGroupName: string
    resourceName: string

    PrivateEndpointConnection 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 PrivateEndpointConnection resource accepts the following input properties:

    Properties Pulumi.AzureNative.DigitalTwins.Inputs.ConnectionProperties
    The connection properties.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    Properties ConnectionPropertiesArgs
    The connection properties.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    properties ConnectionProperties
    The connection properties.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    properties ConnectionProperties
    The connection properties.
    resourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName string
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    properties ConnectionPropertiesArgs
    The connection properties.
    resource_group_name str
    The name of the resource group that contains the DigitalTwinsInstance.
    resource_name str
    The name of the DigitalTwinsInstance.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    properties Property Map
    The connection properties.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName String
    The name of the private endpoint connection.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name.
    SystemData Pulumi.AzureNative.DigitalTwins.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the private endpoint connection.
    Type string
    The resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the private endpoint connection.
    Type string
    The resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the private endpoint connection.
    type String
    The resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the private endpoint connection.
    type string
    The resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the private endpoint connection.
    type str
    The resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name.
    systemData Property Map
    Metadata pertaining to creation and last modification of the private endpoint connection.
    type String
    The resource type.

    Supporting Types

    ConnectionProperties, ConnectionPropertiesArgs

    GroupIds List<string>
    The list of group ids for the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.DigitalTwins.Inputs.ConnectionPropertiesPrivateLinkServiceConnectionState
    The connection state.
    GroupIds []string
    The list of group ids for the private endpoint connection.
    PrivateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
    The connection state.
    groupIds List<String>
    The list of group ids for the private endpoint connection.
    privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
    The connection state.
    groupIds string[]
    The list of group ids for the private endpoint connection.
    privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
    The connection state.
    group_ids Sequence[str]
    The list of group ids for the private endpoint connection.
    private_link_service_connection_state ConnectionPropertiesPrivateLinkServiceConnectionState
    The connection state.
    groupIds List<String>
    The list of group ids for the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    The connection state.

    ConnectionPropertiesPrivateLinkServiceConnectionState, ConnectionPropertiesPrivateLinkServiceConnectionStateArgs

    Description string
    The description for the current state of a private endpoint connection.
    Status string | Pulumi.AzureNative.DigitalTwins.PrivateLinkServiceConnectionStatus
    The status of a private endpoint connection.
    ActionsRequired string
    Actions required for a private endpoint connection.
    Description string
    The description for the current state of a private endpoint connection.
    Status string | PrivateLinkServiceConnectionStatus
    The status of a private endpoint connection.
    ActionsRequired string
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    status String | PrivateLinkServiceConnectionStatus
    The status of a private endpoint connection.
    actionsRequired String
    Actions required for a private endpoint connection.
    description string
    The description for the current state of a private endpoint connection.
    status string | PrivateLinkServiceConnectionStatus
    The status of a private endpoint connection.
    actionsRequired string
    Actions required for a private endpoint connection.
    description str
    The description for the current state of a private endpoint connection.
    status str | PrivateLinkServiceConnectionStatus
    The status of a private endpoint connection.
    actions_required str
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
    The status of a private endpoint connection.
    actionsRequired String
    Actions required for a private endpoint connection.

    ConnectionPropertiesResponse, ConnectionPropertiesResponseArgs

    ProvisioningState string
    The provisioning state.
    GroupIds []string
    The list of group ids for the private endpoint connection.
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint.
    PrivateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
    The connection state.
    provisioningState String
    The provisioning state.
    groupIds List<String>
    The list of group ids for the private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint.
    privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
    The connection state.
    provisioningState string
    The provisioning state.
    groupIds string[]
    The list of group ids for the private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint.
    privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState
    The connection state.
    provisioning_state str
    The provisioning state.
    group_ids Sequence[str]
    The list of group ids for the private endpoint connection.
    private_endpoint PrivateEndpointResponse
    The private endpoint.
    private_link_service_connection_state ConnectionPropertiesResponsePrivateLinkServiceConnectionState
    The connection state.
    provisioningState String
    The provisioning state.
    groupIds List<String>
    The list of group ids for the private endpoint connection.
    privateEndpoint Property Map
    The private endpoint.
    privateLinkServiceConnectionState Property Map
    The connection state.

    ConnectionPropertiesResponsePrivateLinkServiceConnectionState, ConnectionPropertiesResponsePrivateLinkServiceConnectionStateArgs

    Description string
    The description for the current state of a private endpoint connection.
    Status string
    The status of a private endpoint connection.
    ActionsRequired string
    Actions required for a private endpoint connection.
    Description string
    The description for the current state of a private endpoint connection.
    Status string
    The status of a private endpoint connection.
    ActionsRequired string
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    status String
    The status of a private endpoint connection.
    actionsRequired String
    Actions required for a private endpoint connection.
    description string
    The description for the current state of a private endpoint connection.
    status string
    The status of a private endpoint connection.
    actionsRequired string
    Actions required for a private endpoint connection.
    description str
    The description for the current state of a private endpoint connection.
    status str
    The status of a private endpoint connection.
    actions_required str
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    status String
    The status of a private endpoint connection.
    actionsRequired String
    Actions required for a private endpoint connection.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The resource identifier.
    Id string
    The resource identifier.
    id String
    The resource identifier.
    id string
    The resource identifier.
    id str
    The resource identifier.
    id String
    The resource identifier.

    PrivateLinkServiceConnectionStatus, PrivateLinkServiceConnectionStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PrivateLinkServiceConnectionStatusPending
    Pending
    PrivateLinkServiceConnectionStatusApproved
    Approved
    PrivateLinkServiceConnectionStatusRejected
    Rejected
    PrivateLinkServiceConnectionStatusDisconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    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.

    Import

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

    $ pulumi import azure-native:digitaltwins:PrivateEndpointConnection myPrivateConnection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native