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

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.synapse.ManagedPrivateEndpoint

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Synapse 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 exampleAccount = new azure.storage.Account("example", {
    name: "examplestorageacc",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: true,
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
    name: "example",
    storageAccountId: exampleAccount.id,
});
const exampleWorkspace = new azure.synapse.Workspace("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
    managedVirtualNetworkEnabled: true,
    identity: {
        type: "SystemAssigned",
    },
});
const exampleFirewallRule = new azure.synapse.FirewallRule("example", {
    name: "AllowAll",
    synapseWorkspaceId: exampleWorkspace.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});
const exampleConnect = new azure.storage.Account("example_connect", {
    name: "examplestorage2",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "BlobStorage",
});
const exampleManagedPrivateEndpoint = new azure.synapse.ManagedPrivateEndpoint("example", {
    name: "example-endpoint",
    synapseWorkspaceId: exampleWorkspace.id,
    targetResourceId: exampleConnect.id,
    subresourceName: "blob",
}, {
    dependsOn: [exampleFirewallRule],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.storage.Account("example",
    name="examplestorageacc",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
    name="example",
    storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!",
    managed_virtual_network_enabled=True,
    identity={
        "type": "SystemAssigned",
    })
example_firewall_rule = azure.synapse.FirewallRule("example",
    name="AllowAll",
    synapse_workspace_id=example_workspace.id,
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")
example_connect = azure.storage.Account("example_connect",
    name="examplestorage2",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="BlobStorage")
example_managed_private_endpoint = azure.synapse.ManagedPrivateEndpoint("example",
    name="example-endpoint",
    synapse_workspace_id=example_workspace.id,
    target_resource_id=example_connect.id,
    subresource_name="blob",
    opts = pulumi.ResourceOptions(depends_on=[example_firewall_rule]))

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/synapse"
	"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
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorageacc"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
			Name:             pulumi.String("example"),
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
			Name:                            pulumi.String("example"),
			ResourceGroupName:               example.Name,
			Location:                        example.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			ManagedVirtualNetworkEnabled:    pulumi.Bool(true),
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "example", &synapse.FirewallRuleArgs{
			Name:               pulumi.String("AllowAll"),
			SynapseWorkspaceId: exampleWorkspace.ID(),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		if err != nil {
			return err
		}
		exampleConnect, err := storage.NewAccount(ctx, "example_connect", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorage2"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("BlobStorage"),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewManagedPrivateEndpoint(ctx, "example", &synapse.ManagedPrivateEndpointArgs{
			Name:               pulumi.String("example-endpoint"),
			SynapseWorkspaceId: exampleWorkspace.ID(),
			TargetResourceId:   exampleConnect.ID(),
			SubresourceName:    pulumi.String("blob"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleFirewallRule,
		}))
		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 exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplestorageacc",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        AccountKind = "StorageV2",
        IsHnsEnabled = true,
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
    {
        Name = "example",
        StorageAccountId = exampleAccount.Id,
    });

    var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
        SqlAdministratorLogin = "sqladminuser",
        SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        ManagedVirtualNetworkEnabled = true,
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var exampleFirewallRule = new Azure.Synapse.FirewallRule("example", new()
    {
        Name = "AllowAll",
        SynapseWorkspaceId = exampleWorkspace.Id,
        StartIpAddress = "0.0.0.0",
        EndIpAddress = "255.255.255.255",
    });

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

    var exampleManagedPrivateEndpoint = new Azure.Synapse.ManagedPrivateEndpoint("example", new()
    {
        Name = "example-endpoint",
        SynapseWorkspaceId = exampleWorkspace.Id,
        TargetResourceId = exampleConnect.Id,
        SubresourceName = "blob",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleFirewallRule,
        },
    });

});

    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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.FirewallRule;
import com.pulumi.azure.synapse.FirewallRuleArgs;
import com.pulumi.azure.synapse.ManagedPrivateEndpoint;
import com.pulumi.azure.synapse.ManagedPrivateEndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplestorageacc")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .accountKind("StorageV2")
            .isHnsEnabled("true")
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
            .name("example")
            .storageAccountId(exampleAccount.id())
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
            .sqlAdministratorLogin("sqladminuser")
            .sqlAdministratorLoginPassword("H@Sh1CoR3!")
            .managedVirtualNetworkEnabled(true)
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("AllowAll")
            .synapseWorkspaceId(exampleWorkspace.id())
            .startIpAddress("0.0.0.0")
            .endIpAddress("255.255.255.255")
            .build());

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

        var exampleManagedPrivateEndpoint = new ManagedPrivateEndpoint("exampleManagedPrivateEndpoint", ManagedPrivateEndpointArgs.builder()
            .name("example-endpoint")
            .synapseWorkspaceId(exampleWorkspace.id())
            .targetResourceId(exampleConnect.id())
            .subresourceName("blob")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleFirewallRule)
                .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageacc
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    name: example
    properties:
      name: example
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      managedVirtualNetworkEnabled: true
      identity:
        type: SystemAssigned
  exampleFirewallRule:
    type: azure:synapse:FirewallRule
    name: example
    properties:
      name: AllowAll
      synapseWorkspaceId: ${exampleWorkspace.id}
      startIpAddress: 0.0.0.0
      endIpAddress: 255.255.255.255
  exampleConnect:
    type: azure:storage:Account
    name: example_connect
    properties:
      name: examplestorage2
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: BlobStorage
  exampleManagedPrivateEndpoint:
    type: azure:synapse:ManagedPrivateEndpoint
    name: example
    properties:
      name: example-endpoint
      synapseWorkspaceId: ${exampleWorkspace.id}
      targetResourceId: ${exampleConnect.id}
      subresourceName: blob
    options:
      dependson:
        - ${exampleFirewallRule}

    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,
                           subresource_name: Optional[str] = None,
                           synapse_workspace_id: Optional[str] = None,
                           target_resource_id: Optional[str] = None,
                           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:synapse: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 examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint = new Azure.Synapse.ManagedPrivateEndpoint("examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint", new()
{
    SubresourceName = "string",
    SynapseWorkspaceId = "string",
    TargetResourceId = "string",
    Name = "string",
});

    example, err := synapse.NewManagedPrivateEndpoint(ctx, "examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint", &synapse.ManagedPrivateEndpointArgs{
	SubresourceName:    pulumi.String("string"),
	SynapseWorkspaceId: pulumi.String("string"),
	TargetResourceId:   pulumi.String("string"),
	Name:               pulumi.String("string"),
})

    var examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint = new ManagedPrivateEndpoint("examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint", ManagedPrivateEndpointArgs.builder()
    .subresourceName("string")
    .synapseWorkspaceId("string")
    .targetResourceId("string")
    .name("string")
    .build());

    examplemanaged_private_endpoint_resource_resource_from_synapsemanaged_private_endpoint = azure.synapse.ManagedPrivateEndpoint("examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint",
    subresource_name="string",
    synapse_workspace_id="string",
    target_resource_id="string",
    name="string")

    const examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint = new azure.synapse.ManagedPrivateEndpoint("examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint", {
    subresourceName: "string",
    synapseWorkspaceId: "string",
    targetResourceId: "string",
    name: "string",
});

    type: azure:synapse:ManagedPrivateEndpoint
properties:
    name: string
    subresourceName: string
    synapseWorkspaceId: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ManagedPrivateEndpoint resource accepts the following input properties:

    SubresourceName string

    Specifies the sub resource name which the Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    SynapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    SynapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId String

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    name string
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapse_workspace_id str

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    target_resource_id str
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    name str
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId String

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    name String
    Specifies the name which should be used for this Managed Private Endpoint. 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,
        name: Optional[str] = None,
        subresource_name: Optional[str] = None,
        synapse_workspace_id: 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:
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    SynapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    SynapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    TargetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId String

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId string

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId string
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapse_workspace_id str

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    target_resource_id str
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.
    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 Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.

    NOTE: Possible values are listed in documentation.

    synapseWorkspaceId String

    The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.

    NOTE: A Synapse firewall rule including local IP is needed for managing current resource.

    targetResourceId String
    The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created.

    Import

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

    $ pulumi import azure:synapse/managedPrivateEndpoint:ManagedPrivateEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure