Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. ManagedPrivateEndpoint

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.datafactory.ManagedPrivateEndpoint

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Data Factory Managed Private Endpoint.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    managedVirtualNetworkEnabled: true,
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    accountKind: "BlobStorage",
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleManagedPrivateEndpoint = new azure.datafactory.ManagedPrivateEndpoint("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    targetResourceId: exampleAccount.id,
    subresourceName: "blob",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    managed_virtual_network_enabled=True)
example_account = azure.storage.Account("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    account_kind="BlobStorage",
    account_tier="Standard",
    account_replication_type="LRS")
example_managed_private_endpoint = azure.datafactory.ManagedPrivateEndpoint("example",
    name="example",
    data_factory_id=example_factory.id,
    target_resource_id=example_account.id,
    subresource_name="blob")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
			Name:                         pulumi.String("example"),
			Location:                     example.Location,
			ResourceGroupName:            example.Name,
			ManagedVirtualNetworkEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountKind:            pulumi.String("BlobStorage"),
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewManagedPrivateEndpoint(ctx, "example", &datafactory.ManagedPrivateEndpointArgs{
			Name:             pulumi.String("example"),
			DataFactoryId:    exampleFactory.ID(),
			TargetResourceId: exampleAccount.ID(),
			SubresourceName:  pulumi.String("blob"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        ManagedVirtualNetworkEnabled = true,
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountKind = "BlobStorage",
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleManagedPrivateEndpoint = new Azure.DataFactory.ManagedPrivateEndpoint("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        TargetResourceId = exampleAccount.Id,
        SubresourceName = "blob",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.datafactory.ManagedPrivateEndpoint;
import com.pulumi.azure.datafactory.ManagedPrivateEndpointArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .managedVirtualNetworkEnabled(true)
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountKind("BlobStorage")
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleManagedPrivateEndpoint = new ManagedPrivateEndpoint("exampleManagedPrivateEndpoint", ManagedPrivateEndpointArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .targetResourceId(exampleAccount.id())
            .subresourceName("blob")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      managedVirtualNetworkEnabled: true
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountKind: BlobStorage
      accountTier: Standard
      accountReplicationType: LRS
  exampleManagedPrivateEndpoint:
    type: azure:datafactory:ManagedPrivateEndpoint
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      targetResourceId: ${exampleAccount.id}
      subresourceName: blob

    Create ManagedPrivateEndpoint Resource

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

    Constructor syntax

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

@overload
def ManagedPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           data_factory_id: Optional[str] = None,
                           target_resource_id: Optional[str] = None,
                           fqdns: Optional[Sequence[str]] = None,
                           name: Optional[str] = None,
                           subresource_name: Optional[str] = None)
    func NewManagedPrivateEndpoint(ctx *Context, name string, args ManagedPrivateEndpointArgs, opts ...ResourceOption) (*ManagedPrivateEndpoint, error)
    public ManagedPrivateEndpoint(string name, ManagedPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args)
public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args, CustomResourceOptions options)

    type: azure:datafactory:ManagedPrivateEndpoint
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 ManagedPrivateEndpointArgs
    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 ManagedPrivateEndpointArgs
    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 ManagedPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagedPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagedPrivateEndpointArgs
    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 managedPrivateEndpointResource = new Azure.DataFactory.ManagedPrivateEndpoint("managedPrivateEndpointResource", new()
{
    DataFactoryId = "string",
    TargetResourceId = "string",
    Fqdns = new[]
    {
        "string",
    },
    Name = "string",
    SubresourceName = "string",
});

    example, err := datafactory.NewManagedPrivateEndpoint(ctx, "managedPrivateEndpointResource", &datafactory.ManagedPrivateEndpointArgs{
	DataFactoryId:    pulumi.String("string"),
	TargetResourceId: pulumi.String("string"),
	Fqdns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	SubresourceName: pulumi.String("string"),
})

    var managedPrivateEndpointResource = new ManagedPrivateEndpoint("managedPrivateEndpointResource", ManagedPrivateEndpointArgs.builder()
    .dataFactoryId("string")
    .targetResourceId("string")
    .fqdns("string")
    .name("string")
    .subresourceName("string")
    .build());

    managed_private_endpoint_resource = azure.datafactory.ManagedPrivateEndpoint("managedPrivateEndpointResource",
    data_factory_id="string",
    target_resource_id="string",
    fqdns=["string"],
    name="string",
    subresource_name="string")

    const managedPrivateEndpointResource = new azure.datafactory.ManagedPrivateEndpoint("managedPrivateEndpointResource", {
    dataFactoryId: "string",
    targetResourceId: "string",
    fqdns: ["string"],
    name: "string",
    subresourceName: "string",
});

    type: azure:datafactory:ManagedPrivateEndpoint
properties:
    dataFactoryId: string
    fqdns:
        - string
    name: string
    subresourceName: string
    targetResourceId: string

    ManagedPrivateEndpoint Resource Properties

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

    Inputs

    The ManagedPrivateEndpoint resource accepts the following input properties:

    DataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    Fqdns List<string>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    Name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    SubresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    DataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    Fqdns []string

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    Name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    SubresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    dataFactoryId String
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    fqdns List<String>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name String
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName String
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    dataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    targetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    fqdns string[]

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    data_factory_id str
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    target_resource_id str
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    fqdns Sequence[str]

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name str
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresource_name str
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    dataFactoryId String
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    fqdns List<String>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name String
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName String
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ManagedPrivateEndpoint Resource

    Get an existing ManagedPrivateEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ManagedPrivateEndpointState, opts?: CustomResourceOptions): ManagedPrivateEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_factory_id: Optional[str] = None,
        fqdns: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        subresource_name: Optional[str] = None,
        target_resource_id: Optional[str] = None) -> ManagedPrivateEndpoint
    func GetManagedPrivateEndpoint(ctx *Context, name string, id IDInput, state *ManagedPrivateEndpointState, opts ...ResourceOption) (*ManagedPrivateEndpoint, error)
    public static ManagedPrivateEndpoint Get(string name, Input<string> id, ManagedPrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static ManagedPrivateEndpoint get(String name, Output<String> id, ManagedPrivateEndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    Fqdns List<string>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    Name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    SubresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    DataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    Fqdns []string

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    Name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    SubresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    dataFactoryId String
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    fqdns List<String>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name String
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName String
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    dataFactoryId string
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    fqdns string[]

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name string
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName string
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    targetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    data_factory_id str
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    fqdns Sequence[str]

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name str
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresource_name str
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    target_resource_id str
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.
    dataFactoryId String
    The ID of the Data Factory on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
    fqdns List<String>

    Fully qualified domain names. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    name String
    Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created.
    subresourceName String
    Specifies the sub resource name which the Data Factory Private Endpoint is able to connect to. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Data Factory Private Endpoint should be connected to. Changing this forces a new resource to be created.

    Import

    Data Factory Managed Private Endpoint can be imported using the resource id, e.g.

    $ pulumi import azure:datafactory/managedPrivateEndpoint:ManagedPrivateEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/managedVirtualNetworks/default/managedPrivateEndpoints/endpoint1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure