Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  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 v3.5.1 published on Friday, Jun 6, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.PrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.1 published on Friday, Jun 6, 2025 by Pulumi
pulumi/pulumi-azure-native

    A private endpoint connection

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

    Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

    Example Usage

    Approve private endpoint connection

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Synapse.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "ExamplePrivateEndpointConnection",
        PrivateLinkServiceConnectionState = new AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "Approved by abc@example.com",
            Status = "Approved",
        },
        ResourceGroupName = "ExampleResourceGroup",
        WorkspaceName = "ExampleWorkspace",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &synapse.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("ExamplePrivateEndpointConnection"),
			PrivateLinkServiceConnectionState: &synapse.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("Approved by abc@example.com"),
				Status:      pulumi.String("Approved"),
			},
			ResourceGroupName: pulumi.String("ExampleResourceGroup"),
			WorkspaceName:     pulumi.String("ExampleWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.PrivateEndpointConnection;
import com.pulumi.azurenative.synapse.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.synapse.inputs.PrivateLinkServiceConnectionStateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
            .privateEndpointConnectionName("ExamplePrivateEndpointConnection")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("Approved by abc@example.com")
                .status("Approved")
                .build())
            .resourceGroupName("ExampleResourceGroup")
            .workspaceName("ExampleWorkspace")
            .build());

    }
}

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

const privateEndpointConnection = new azure_native.synapse.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "ExamplePrivateEndpointConnection",
    privateLinkServiceConnectionState: {
        description: "Approved by abc@example.com",
        status: "Approved",
    },
    resourceGroupName: "ExampleResourceGroup",
    workspaceName: "ExampleWorkspace",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.synapse.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="ExamplePrivateEndpointConnection",
    private_link_service_connection_state={
        "description": "Approved by abc@example.com",
        "status": "Approved",
    },
    resource_group_name="ExampleResourceGroup",
    workspace_name="ExampleWorkspace")

    resources:
  privateEndpointConnection:
    type: azure-native:synapse:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: ExamplePrivateEndpointConnection
      privateLinkServiceConnectionState:
        description: Approved by abc@example.com
        status: Approved
      resourceGroupName: ExampleResourceGroup
      workspaceName: ExampleWorkspace

    Create PrivateEndpointConnection Resource

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

    Constructor syntax

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

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              resource_group_name: Optional[str] = None,
                              workspace_name: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = 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:synapse:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateEndpointConnectionInitArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateEndpointConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleprivateEndpointConnectionResourceResourceFromSynapse = new AzureNative.Synapse.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSynapse", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        Description = "string",
        Status = "string",
    },
});

    example, err := synapse.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromSynapse", &synapse.PrivateEndpointConnectionArgs{
	ResourceGroupName:             pulumi.String("string"),
	WorkspaceName:                 pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &synapse.PrivateLinkServiceConnectionStateArgs{
		Description: pulumi.String("string"),
		Status:      pulumi.String("string"),
	},
})

    var exampleprivateEndpointConnectionResourceResourceFromSynapse = new com.pulumi.azurenative.synapse.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSynapse", com.pulumi.azurenative.synapse.PrivateEndpointConnectionArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .description("string")
        .status("string")
        .build())
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_synapse = azure_native.synapse.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSynapse",
    resource_group_name="string",
    workspace_name="string",
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "description": "string",
        "status": "string",
    })

    const exampleprivateEndpointConnectionResourceResourceFromSynapse = new azure_native.synapse.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromSynapse", {
    resourceGroupName: "string",
    workspaceName: "string",
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        description: "string",
        status: "string",
    },
});

    type: azure-native:synapse:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        description: string
        status: string
    resourceGroupName: string
    workspaceName: string

    PrivateEndpointConnection Resource Properties

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

    Inputs

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

    The PrivateEndpointConnection resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionState
    Connection state of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    Connection state of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Connection state of the private endpoint connection.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Connection state of the private endpoint connection.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    Connection state of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    Connection state of the private endpoint connection.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint Pulumi.AzureNative.Synapse.Outputs.PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the private endpoint connection.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the private endpoint connection.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the private endpoint connection.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_endpoint PrivateEndpointResponse
    The private endpoint which the connection belongs to.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the private endpoint connection.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint Property Map
    The private endpoint which the connection belongs to.

    Supporting Types

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    The actions required for private link service connection.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    The actions required for private link service connection.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    Import

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

    $ pulumi import azure-native:synapse:PrivateEndpointConnection sql /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.5.1 published on Friday, Jun 6, 2025 by Pulumi
    pulumi/pulumi-azure-native