We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages a Synapse Managed Private Endpoint.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
AccountKind = "StorageV2",
IsHnsEnabled = true,
});
var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
{
StorageAccountId = exampleAccount.Id,
});
var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
SqlAdministratorLogin = "sqladminuser",
SqlAdministratorLoginPassword = "H@Sh1CoR3!",
ManagedVirtualNetworkEnabled = true,
});
var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new Azure.Synapse.FirewallRuleArgs
{
SynapseWorkspaceId = azurerm_synapse_workspace.Test.Id,
StartIpAddress = "0.0.0.0",
EndIpAddress = "255.255.255.255",
});
var exampleConnect = new Azure.Storage.Account("exampleConnect", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
AccountKind = "BlobStorage",
});
var exampleManagedPrivateEndpoint = new Azure.Synapse.ManagedPrivateEndpoint("exampleManagedPrivateEndpoint", new Azure.Synapse.ManagedPrivateEndpointArgs
{
SynapseWorkspaceId = exampleWorkspace.Id,
TargetResourceId = exampleConnect.Id,
SubresourceName = "blob",
}, new CustomResourceOptions
{
DependsOn =
{
exampleFirewallRule,
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/synapse"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.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, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
StorageAccountId: exampleAccount.ID(),
})
if err != nil {
return err
}
exampleWorkspace, err := synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
SqlAdministratorLogin: pulumi.String("sqladminuser"),
SqlAdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
ManagedVirtualNetworkEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
SynapseWorkspaceId: pulumi.Any(azurerm_synapse_workspace.Test.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, "exampleConnect", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
AccountKind: pulumi.String("BlobStorage"),
})
if err != nil {
return err
}
_, err = synapse.NewManagedPrivateEndpoint(ctx, "exampleManagedPrivateEndpoint", &synapse.ManagedPrivateEndpointArgs{
SynapseWorkspaceId: exampleWorkspace.ID(),
TargetResourceId: exampleConnect.ID(),
SubresourceName: pulumi.String("blob"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleFirewallRule,
}))
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
accountKind: "StorageV2",
isHnsEnabled: "true",
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
sqlAdministratorLogin: "sqladminuser",
sqlAdministratorLoginPassword: "H@Sh1CoR3!",
managedVirtualNetworkEnabled: true,
});
const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
synapseWorkspaceId: azurerm_synapse_workspace.test.id,
startIpAddress: "0.0.0.0",
endIpAddress: "255.255.255.255",
});
const exampleConnect = new azure.storage.Account("exampleConnect", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
accountKind: "BlobStorage",
});
const exampleManagedPrivateEndpoint = new azure.synapse.ManagedPrivateEndpoint("exampleManagedPrivateEndpoint", {
synapseWorkspaceId: exampleWorkspace.id,
targetResourceId: exampleConnect.id,
subresourceName: "blob",
}, {
dependsOn: [exampleFirewallRule],
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS",
account_kind="StorageV2",
is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("exampleWorkspace",
resource_group_name=example_resource_group.name,
location=example_resource_group.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)
example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
synapse_workspace_id=azurerm_synapse_workspace["test"]["id"],
start_ip_address="0.0.0.0",
end_ip_address="255.255.255.255")
example_connect = azure.storage.Account("exampleConnect",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS",
account_kind="BlobStorage")
example_managed_private_endpoint = azure.synapse.ManagedPrivateEndpoint("exampleManagedPrivateEndpoint",
synapse_workspace_id=example_workspace.id,
target_resource_id=example_connect.id,
subresource_name="blob",
opts=pulumi.ResourceOptions(depends_on=[example_firewall_rule]))
Example coming soon!
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 com.pulumi.azure.synapse.ManagedPrivateEndpoint("examplemanagedPrivateEndpointResourceResourceFromSynapsemanagedPrivateEndpoint", com.pulumi.azure.synapse.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:
- Subresource
Name 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.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- Target
Resource stringId - 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 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.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- Target
Resource stringId - 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 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.
- synapse
Workspace StringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource StringId - 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 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.
- synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource stringId - 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.
- synapse_
workspace_ strid - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target_
resource_ strid - 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 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.
- synapse
Workspace StringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource StringId - 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) -> ManagedPrivateEndpointfunc 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)resources: _: type: azure:synapse:ManagedPrivateEndpoint get: id: ${id}- 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.
- 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 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.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- Target
Resource stringId - 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 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.
- Synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- Target
Resource stringId - 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 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.
- synapse
Workspace StringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource StringId - 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 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.
- synapse
Workspace stringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource stringId - 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.
- synapse_
workspace_ strid - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target_
resource_ strid - 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 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.
- synapse
Workspace StringId - The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
- target
Resource StringId - 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
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
