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

azure-native.datafactory.PrivateEndpointConnection

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 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Private Endpoint Connection ARM resource.

Uses Azure REST API version 2018-06-01. In version 1.x of the Azure Native provider, it used API version 2018-06-01.

Example Usage

Approves or rejects a private endpoint connection for a factory.

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.DataFactory.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        FactoryName = "exampleFactoryName",
        PrivateEndpointConnectionName = "connection",
        Properties = new AzureNative.DataFactory.Inputs.PrivateLinkConnectionApprovalRequestArgs
        {
            PrivateEndpoint = new AzureNative.DataFactory.Inputs.PrivateEndpointArgs
            {
                Id = "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint",
            },
            PrivateLinkServiceConnectionState = new AzureNative.DataFactory.Inputs.PrivateLinkConnectionStateArgs
            {
                ActionsRequired = "",
                Description = "Approved by admin.",
                Status = "Approved",
            },
        },
        ResourceGroupName = "exampleResourceGroup",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datafactory.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &datafactory.PrivateEndpointConnectionArgs{
			FactoryName:                   pulumi.String("exampleFactoryName"),
			PrivateEndpointConnectionName: pulumi.String("connection"),
			Properties: &datafactory.PrivateLinkConnectionApprovalRequestArgs{
				PrivateEndpoint: &datafactory.PrivateEndpointArgs{
					Id: pulumi.String("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint"),
				},
				PrivateLinkServiceConnectionState: &datafactory.PrivateLinkConnectionStateArgs{
					ActionsRequired: pulumi.String(""),
					Description:     pulumi.String("Approved by admin."),
					Status:          pulumi.String("Approved"),
				},
			},
			ResourceGroupName: pulumi.String("exampleResourceGroup"),
		})
		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.datafactory.PrivateEndpointConnection;
import com.pulumi.azurenative.datafactory.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.datafactory.inputs.PrivateLinkConnectionApprovalRequestArgs;
import com.pulumi.azurenative.datafactory.inputs.PrivateEndpointArgs;
import com.pulumi.azurenative.datafactory.inputs.PrivateLinkConnectionStateArgs;
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()
            .factoryName("exampleFactoryName")
            .privateEndpointConnectionName("connection")
            .properties(PrivateLinkConnectionApprovalRequestArgs.builder()
                .privateEndpoint(PrivateEndpointArgs.builder()
                    .id("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint")
                    .build())
                .privateLinkServiceConnectionState(PrivateLinkConnectionStateArgs.builder()
                    .actionsRequired("")
                    .description("Approved by admin.")
                    .status("Approved")
                    .build())
                .build())
            .resourceGroupName("exampleResourceGroup")
            .build());

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

const privateEndpointConnection = new azure_native.datafactory.PrivateEndpointConnection("privateEndpointConnection", {
    factoryName: "exampleFactoryName",
    privateEndpointConnectionName: "connection",
    properties: {
        privateEndpoint: {
            id: "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint",
        },
        privateLinkServiceConnectionState: {
            actionsRequired: "",
            description: "Approved by admin.",
            status: "Approved",
        },
    },
    resourceGroupName: "exampleResourceGroup",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.datafactory.PrivateEndpointConnection("privateEndpointConnection",
    factory_name="exampleFactoryName",
    private_endpoint_connection_name="connection",
    properties={
        "private_endpoint": {
            "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint",
        },
        "private_link_service_connection_state": {
            "actions_required": "",
            "description": "Approved by admin.",
            "status": "Approved",
        },
    },
    resource_group_name="exampleResourceGroup")
Copy
resources:
  privateEndpointConnection:
    type: azure-native:datafactory:PrivateEndpointConnection
    properties:
      factoryName: exampleFactoryName
      privateEndpointConnectionName: connection
      properties:
        privateEndpoint:
          id: /subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint
        privateLinkServiceConnectionState:
          actionsRequired: ""
          description: Approved by admin.
          status: Approved
      resourceGroupName: exampleResourceGroup
Copy

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: PrivateEndpointConnectionArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              factory_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              properties: Optional[PrivateLinkConnectionApprovalRequestArgs] = 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:datafactory:PrivateEndpointConnection
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. 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 exampleprivateEndpointConnectionResourceResourceFromDatafactory = new AzureNative.DataFactory.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatafactory", new()
{
    FactoryName = "string",
    ResourceGroupName = "string",
    PrivateEndpointConnectionName = "string",
    Properties = new AzureNative.DataFactory.Inputs.PrivateLinkConnectionApprovalRequestArgs
    {
        PrivateEndpoint = new AzureNative.DataFactory.Inputs.PrivateEndpointArgs
        {
            Id = "string",
        },
        PrivateLinkServiceConnectionState = new AzureNative.DataFactory.Inputs.PrivateLinkConnectionStateArgs
        {
            ActionsRequired = "string",
            Description = "string",
            Status = "string",
        },
    },
});
Copy
example, err := datafactory.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDatafactory", &datafactory.PrivateEndpointConnectionArgs{
	FactoryName:                   pulumi.String("string"),
	ResourceGroupName:             pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
	Properties: &datafactory.PrivateLinkConnectionApprovalRequestArgs{
		PrivateEndpoint: &datafactory.PrivateEndpointArgs{
			Id: pulumi.String("string"),
		},
		PrivateLinkServiceConnectionState: &datafactory.PrivateLinkConnectionStateArgs{
			ActionsRequired: pulumi.String("string"),
			Description:     pulumi.String("string"),
			Status:          pulumi.String("string"),
		},
	},
})
Copy
var exampleprivateEndpointConnectionResourceResourceFromDatafactory = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatafactory", PrivateEndpointConnectionArgs.builder()
    .factoryName("string")
    .resourceGroupName("string")
    .privateEndpointConnectionName("string")
    .properties(PrivateLinkConnectionApprovalRequestArgs.builder()
        .privateEndpoint(PrivateEndpointArgs.builder()
            .id("string")
            .build())
        .privateLinkServiceConnectionState(PrivateLinkConnectionStateArgs.builder()
            .actionsRequired("string")
            .description("string")
            .status("string")
            .build())
        .build())
    .build());
Copy
exampleprivate_endpoint_connection_resource_resource_from_datafactory = azure_native.datafactory.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatafactory",
    factory_name="string",
    resource_group_name="string",
    private_endpoint_connection_name="string",
    properties={
        "private_endpoint": {
            "id": "string",
        },
        "private_link_service_connection_state": {
            "actions_required": "string",
            "description": "string",
            "status": "string",
        },
    })
Copy
const exampleprivateEndpointConnectionResourceResourceFromDatafactory = new azure_native.datafactory.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatafactory", {
    factoryName: "string",
    resourceGroupName: "string",
    privateEndpointConnectionName: "string",
    properties: {
        privateEndpoint: {
            id: "string",
        },
        privateLinkServiceConnectionState: {
            actionsRequired: "string",
            description: "string",
            status: "string",
        },
    },
});
Copy
type: azure-native:datafactory:PrivateEndpointConnection
properties:
    factoryName: string
    privateEndpointConnectionName: string
    properties:
        privateEndpoint:
            id: string
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
    resourceGroupName: string
Copy

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:

FactoryName
This property is required.
Changes to this property will trigger replacement.
string
The factory name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The private endpoint connection name.
Properties Pulumi.AzureNative.DataFactory.Inputs.PrivateLinkConnectionApprovalRequest
Core resource properties
FactoryName
This property is required.
Changes to this property will trigger replacement.
string
The factory name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The private endpoint connection name.
Properties PrivateLinkConnectionApprovalRequestArgs
Core resource properties
factoryName
This property is required.
Changes to this property will trigger replacement.
String
The factory name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
privateEndpointConnectionName Changes to this property will trigger replacement. String
The private endpoint connection name.
properties PrivateLinkConnectionApprovalRequest
Core resource properties
factoryName
This property is required.
Changes to this property will trigger replacement.
string
The factory name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
privateEndpointConnectionName Changes to this property will trigger replacement. string
The private endpoint connection name.
properties PrivateLinkConnectionApprovalRequest
Core resource properties
factory_name
This property is required.
Changes to this property will trigger replacement.
str
The factory name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
private_endpoint_connection_name Changes to this property will trigger replacement. str
The private endpoint connection name.
properties PrivateLinkConnectionApprovalRequestArgs
Core resource properties
factoryName
This property is required.
Changes to this property will trigger replacement.
String
The factory name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
privateEndpointConnectionName Changes to this property will trigger replacement. String
The private endpoint connection name.
properties Property Map
Core resource properties

Outputs

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

Etag string
Etag identifies change in the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name.
Type string
The resource type.
Etag string
Etag identifies change in the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name.
Type string
The resource type.
etag String
Etag identifies change in the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name.
type String
The resource type.
etag string
Etag identifies change in the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name.
type string
The resource type.
etag str
Etag identifies change in the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource name.
type str
The resource type.
etag String
Etag identifies change in the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name.
type String
The resource type.

Supporting Types

ArmIdWrapperResponse
, ArmIdWrapperResponseArgs

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

PrivateEndpoint
, PrivateEndpointArgs

Id string
The resource Id for private endpoint
Id string
The resource Id for private endpoint
id String
The resource Id for private endpoint
id string
The resource Id for private endpoint
id str
The resource Id for private endpoint
id String
The resource Id for private endpoint

PrivateLinkConnectionApprovalRequest
, PrivateLinkConnectionApprovalRequestArgs

PrivateEndpoint PrivateEndpoint
The resource of private endpoint.
PrivateLinkServiceConnectionState PrivateLinkConnectionState
The state of a private link connection
privateEndpoint PrivateEndpoint
The resource of private endpoint.
privateLinkServiceConnectionState PrivateLinkConnectionState
The state of a private link connection
privateEndpoint PrivateEndpoint
The resource of private endpoint.
privateLinkServiceConnectionState PrivateLinkConnectionState
The state of a private link connection
private_endpoint PrivateEndpoint
The resource of private endpoint.
private_link_service_connection_state PrivateLinkConnectionState
The state of a private link connection
privateEndpoint Property Map
The resource of private endpoint.
privateLinkServiceConnectionState Property Map
The state of a private link connection

PrivateLinkConnectionState
, PrivateLinkConnectionStateArgs

ActionsRequired string
ActionsRequired for a private link connection
Description string
Description of a private link connection
Status string
Status of a private link connection
ActionsRequired string
ActionsRequired for a private link connection
Description string
Description of a private link connection
Status string
Status of a private link connection
actionsRequired String
ActionsRequired for a private link connection
description String
Description of a private link connection
status String
Status of a private link connection
actionsRequired string
ActionsRequired for a private link connection
description string
Description of a private link connection
status string
Status of a private link connection
actions_required str
ActionsRequired for a private link connection
description str
Description of a private link connection
status str
Status of a private link connection
actionsRequired String
ActionsRequired for a private link connection
description String
Description of a private link connection
status String
Status of a private link connection

PrivateLinkConnectionStateResponse
, PrivateLinkConnectionStateResponseArgs

ActionsRequired string
ActionsRequired for a private link connection
Description string
Description of a private link connection
Status string
Status of a private link connection
ActionsRequired string
ActionsRequired for a private link connection
Description string
Description of a private link connection
Status string
Status of a private link connection
actionsRequired String
ActionsRequired for a private link connection
description String
Description of a private link connection
status String
Status of a private link connection
actionsRequired string
ActionsRequired for a private link connection
description string
Description of a private link connection
status string
Status of a private link connection
actions_required str
ActionsRequired for a private link connection
description str
Description of a private link connection
status str
Status of a private link connection
actionsRequired String
ActionsRequired for a private link connection
description String
Description of a private link connection
status String
Status of a private link connection

RemotePrivateEndpointConnectionResponse
, RemotePrivateEndpointConnectionResponseArgs

ProvisioningState This property is required. string
PrivateEndpoint ArmIdWrapperResponse
PrivateEndpoint of a remote private endpoint connection
PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse
The state of a private link connection
provisioningState This property is required. String
privateEndpoint ArmIdWrapperResponse
PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
The state of a private link connection
provisioningState This property is required. string
privateEndpoint ArmIdWrapperResponse
PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
The state of a private link connection
provisioning_state This property is required. str
private_endpoint ArmIdWrapperResponse
PrivateEndpoint of a remote private endpoint connection
private_link_service_connection_state PrivateLinkConnectionStateResponse
The state of a private link connection
provisioningState This property is required. String
privateEndpoint Property Map
PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState Property Map
The state of a private link connection

Import

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

$ pulumi import azure-native:datafactory:PrivateEndpointConnection exampleFactoryName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
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 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native