1. Packages
  2. Azure Native
  3. API Docs
  4. databricks
  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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.databricks.PrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

The private endpoint connection of a workspace

Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Other available API versions: 2023-02-01, 2023-09-15-preview, 2024-09-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databricks [ApiVersion]. See the version guide for details.

Example Usage

Update a private endpoint connection

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Databricks.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "myWorkspace.23456789-1111-1111-1111-111111111111",
        Properties = new AzureNative.Databricks.Inputs.PrivateEndpointConnectionPropertiesArgs
        {
            PrivateLinkServiceConnectionState = new AzureNative.Databricks.Inputs.PrivateLinkServiceConnectionStateArgs
            {
                Description = "Approved by databricksadmin@contoso.com",
                Status = AzureNative.Databricks.PrivateLinkServiceConnectionStatus.Approved,
            },
        },
        ResourceGroupName = "myResourceGroup",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &databricks.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("myWorkspace.23456789-1111-1111-1111-111111111111"),
			Properties: &databricks.PrivateEndpointConnectionPropertiesArgs{
				PrivateLinkServiceConnectionState: &databricks.PrivateLinkServiceConnectionStateArgs{
					Description: pulumi.String("Approved by databricksadmin@contoso.com"),
					Status:      pulumi.String(databricks.PrivateLinkServiceConnectionStatusApproved),
				},
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databricks.PrivateEndpointConnection;
import com.pulumi.azurenative.databricks.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.databricks.inputs.PrivateEndpointConnectionPropertiesArgs;
import com.pulumi.azurenative.databricks.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("myWorkspace.23456789-1111-1111-1111-111111111111")
            .properties(PrivateEndpointConnectionPropertiesArgs.builder()
                .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                    .description("Approved by databricksadmin@contoso.com")
                    .status("Approved")
                    .build())
                .build())
            .resourceGroupName("myResourceGroup")
            .workspaceName("myWorkspace")
            .build());

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

const privateEndpointConnection = new azure_native.databricks.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "myWorkspace.23456789-1111-1111-1111-111111111111",
    properties: {
        privateLinkServiceConnectionState: {
            description: "Approved by databricksadmin@contoso.com",
            status: azure_native.databricks.PrivateLinkServiceConnectionStatus.Approved,
        },
    },
    resourceGroupName: "myResourceGroup",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.databricks.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="myWorkspace.23456789-1111-1111-1111-111111111111",
    properties={
        "private_link_service_connection_state": {
            "description": "Approved by databricksadmin@contoso.com",
            "status": azure_native.databricks.PrivateLinkServiceConnectionStatus.APPROVED,
        },
    },
    resource_group_name="myResourceGroup",
    workspace_name="myWorkspace")
Copy
resources:
  privateEndpointConnection:
    type: azure-native:databricks:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: myWorkspace.23456789-1111-1111-1111-111111111111
      properties:
        privateLinkServiceConnectionState:
          description: Approved by databricksadmin@contoso.com
          status: Approved
      resourceGroupName: myResourceGroup
      workspaceName: myWorkspace
Copy

Create PrivateEndpointConnection Resource

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

Constructor syntax

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

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

Parameters

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

Constructor example

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

var exampleprivateEndpointConnectionResourceResourceFromDatabricks = new AzureNative.Databricks.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatabricks", new()
{
    Properties = new AzureNative.Databricks.Inputs.PrivateEndpointConnectionPropertiesArgs
    {
        PrivateLinkServiceConnectionState = new AzureNative.Databricks.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Status = "string",
            ActionsRequired = "string",
            Description = "string",
        },
        GroupIds = new[]
        {
            "string",
        },
    },
    ResourceGroupName = "string",
    WorkspaceName = "string",
    PrivateEndpointConnectionName = "string",
});
Copy
example, err := databricks.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDatabricks", &databricks.PrivateEndpointConnectionArgs{
	Properties: &databricks.PrivateEndpointConnectionPropertiesArgs{
		PrivateLinkServiceConnectionState: &databricks.PrivateLinkServiceConnectionStateArgs{
			Status:          pulumi.String("string"),
			ActionsRequired: pulumi.String("string"),
			Description:     pulumi.String("string"),
		},
		GroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ResourceGroupName:             pulumi.String("string"),
	WorkspaceName:                 pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})
Copy
var exampleprivateEndpointConnectionResourceResourceFromDatabricks = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatabricks", PrivateEndpointConnectionArgs.builder()
    .properties(PrivateEndpointConnectionPropertiesArgs.builder()
        .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
            .status("string")
            .actionsRequired("string")
            .description("string")
            .build())
        .groupIds("string")
        .build())
    .resourceGroupName("string")
    .workspaceName("string")
    .privateEndpointConnectionName("string")
    .build());
Copy
exampleprivate_endpoint_connection_resource_resource_from_databricks = azure_native.databricks.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatabricks",
    properties={
        "private_link_service_connection_state": {
            "status": "string",
            "actions_required": "string",
            "description": "string",
        },
        "group_ids": ["string"],
    },
    resource_group_name="string",
    workspace_name="string",
    private_endpoint_connection_name="string")
Copy
const exampleprivateEndpointConnectionResourceResourceFromDatabricks = new azure_native.databricks.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatabricks", {
    properties: {
        privateLinkServiceConnectionState: {
            status: "string",
            actionsRequired: "string",
            description: "string",
        },
        groupIds: ["string"],
    },
    resourceGroupName: "string",
    workspaceName: "string",
    privateEndpointConnectionName: "string",
});
Copy
type: azure-native:databricks:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    properties:
        groupIds:
            - string
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
    resourceGroupName: string
    workspaceName: string
Copy

PrivateEndpointConnection Resource Properties

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

Inputs

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

The PrivateEndpointConnection resource accepts the following input properties:

Properties This property is required. Pulumi.AzureNative.Databricks.Inputs.PrivateEndpointConnectionProperties
The private endpoint connection properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection
Properties This property is required. PrivateEndpointConnectionPropertiesArgs
The private endpoint connection properties.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection
properties This property is required. PrivateEndpointConnectionProperties
The private endpoint connection properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
privateEndpointConnectionName Changes to this property will trigger replacement. String
The name of the private endpoint connection
properties This property is required. PrivateEndpointConnectionProperties
The private endpoint connection properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
privateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection
properties This property is required. PrivateEndpointConnectionPropertiesArgs
The private endpoint connection properties.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
private_endpoint_connection_name Changes to this property will trigger replacement. str
The name of the private endpoint connection
properties This property is required. Property Map
The private endpoint connection properties.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
privateEndpointConnectionName Changes to this property will trigger replacement. String
The name 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 resource name.
Type string
The resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name.
Type string
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name.
type String
The resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name.
type string
The resource type.
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 resource name.
type str
The resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name.
type String
The resource type.

Supporting Types

PrivateEndpointConnectionProperties
, PrivateEndpointConnectionPropertiesArgs

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Databricks.Inputs.PrivateLinkServiceConnectionState
Private endpoint connection state
GroupIds List<string>
GroupIds from the private link service resource.
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
Private endpoint connection state
GroupIds []string
GroupIds from the private link service resource.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
Private endpoint connection state
groupIds List<String>
GroupIds from the private link service resource.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
Private endpoint connection state
groupIds string[]
GroupIds from the private link service resource.
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionState
Private endpoint connection state
group_ids Sequence[str]
GroupIds from the private link service resource.
privateLinkServiceConnectionState This property is required. Property Map
Private endpoint connection state
groupIds List<String>
GroupIds from the private link service resource.

PrivateEndpointConnectionPropertiesResponse
, PrivateEndpointConnectionPropertiesResponseArgs

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Databricks.Inputs.PrivateLinkServiceConnectionStateResponse
Private endpoint connection state
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
GroupIds List<string>
GroupIds from the private link service resource.
PrivateEndpoint Pulumi.AzureNative.Databricks.Inputs.PrivateEndpointResponse
Private endpoint
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
Private endpoint connection state
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
GroupIds []string
GroupIds from the private link service resource.
PrivateEndpoint PrivateEndpointResponse
Private endpoint
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
Private endpoint connection state
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
groupIds List<String>
GroupIds from the private link service resource.
privateEndpoint PrivateEndpointResponse
Private endpoint
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
Private endpoint connection state
provisioningState This property is required. string
Provisioning state of the private endpoint connection.
groupIds string[]
GroupIds from the private link service resource.
privateEndpoint PrivateEndpointResponse
Private endpoint
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
Private endpoint connection state
provisioning_state This property is required. str
Provisioning state of the private endpoint connection.
group_ids Sequence[str]
GroupIds from the private link service resource.
private_endpoint PrivateEndpointResponse
Private endpoint
privateLinkServiceConnectionState This property is required. Property Map
Private endpoint connection state
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
groupIds List<String>
GroupIds from the private link service resource.
privateEndpoint Property Map
Private endpoint

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id This property is required. string
The resource identifier.
Id This property is required. string
The resource identifier.
id This property is required. String
The resource identifier.
id This property is required. string
The resource identifier.
id This property is required. str
The resource identifier.
id This property is required. String
The resource identifier.

PrivateLinkServiceConnectionState
, PrivateLinkServiceConnectionStateArgs

Status This property is required. string | Pulumi.AzureNative.Databricks.PrivateLinkServiceConnectionStatus
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description string
The description for the current state of a private endpoint connection
Status This property is required. string | PrivateLinkServiceConnectionStatus
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description string
The description for the current state of a private endpoint connection
status This property is required. String | PrivateLinkServiceConnectionStatus
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description String
The description for the current state of a private endpoint connection
status This property is required. string | PrivateLinkServiceConnectionStatus
The status of a private endpoint connection
actionsRequired string
Actions required for a private endpoint connection
description string
The description for the current state of a private endpoint connection
status This property is required. str | PrivateLinkServiceConnectionStatus
The status of a private endpoint connection
actions_required str
Actions required for a private endpoint connection
description str
The description for the current state of a private endpoint connection
status This property is required. String | "Pending" | "Approved" | "Rejected" | "Disconnected"
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description String
The description for the current state of a private endpoint connection

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description string
The description for the current state of a private endpoint connection
Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description string
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description String
The description for the current state of a private endpoint connection
status This property is required. string
The status of a private endpoint connection
actionsRequired string
Actions required for a private endpoint connection
description string
The description for the current state of a private endpoint connection
status This property is required. str
The status of a private endpoint connection
actions_required str
Actions required for a private endpoint connection
description str
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description String
The description for the current state of a private endpoint connection

PrivateLinkServiceConnectionStatus
, PrivateLinkServiceConnectionStatusArgs

Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
PrivateLinkServiceConnectionStatusPending
Pending
PrivateLinkServiceConnectionStatusApproved
Approved
PrivateLinkServiceConnectionStatusRejected
Rejected
PrivateLinkServiceConnectionStatusDisconnected
Disconnected
Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
PENDING
Pending
APPROVED
Approved
REJECTED
Rejected
DISCONNECTED
Disconnected
"Pending"
Pending
"Approved"
Approved
"Rejected"
Rejected
"Disconnected"
Disconnected

Import

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

$ pulumi import azure-native:databricks:PrivateEndpointConnection myWorkspace.23456789-1111-1111-1111-111111111111 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi