azure-native.databricks.PrivateEndpointConnection
Explore with Pulumi AI
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.
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",
});
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"),
})
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());
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")
const exampleprivateEndpointConnectionResourceResourceFromDatabricks = new azure_native.databricks.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDatabricks", {
properties: {
privateLinkServiceConnectionState: {
status: "string",
actionsRequired: "string",
description: "string",
},
groupIds: ["string"],
},
resourceGroupName: "string",
workspaceName: "string",
privateEndpointConnectionName: "string",
});
type: azure-native:databricks:PrivateEndpointConnection
properties:
privateEndpointConnectionName: string
properties:
groupIds:
- string
privateLinkServiceConnectionState:
actionsRequired: string
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:
- Properties
This property is required. Pulumi.Azure Native. Databricks. Inputs. Private Endpoint Connection Properties - The private endpoint connection properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection
- Properties
This property is required. PrivateEndpoint Connection Properties Args - The private endpoint connection properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection
- properties
This property is required. PrivateEndpoint Connection Properties - The private endpoint connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection
- properties
This property is required. PrivateEndpoint Connection Properties - The private endpoint connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection
- properties
This property is required. PrivateEndpoint Connection Properties Args - The private endpoint connection properties.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- private_
endpoint_ connection_ name Changes to this property will trigger replacement.
- The name of the private endpoint connection
- properties
This property is required. Property Map - The private endpoint connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- 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:
- Azure
Api stringVersion - 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 stringVersion - 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 StringVersion - 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 stringVersion - 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_ strversion - 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.
- azure
Api StringVersion - 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
- Private
Link Service Connection State This property is required. Pulumi.Azure Native. Databricks. Inputs. Private Link Service Connection State - Private endpoint connection state
- Group
Ids List<string> - GroupIds from the private link service resource.
- Private
Link Service Connection State This property is required. PrivateLink Service Connection State - Private endpoint connection state
- Group
Ids []string - GroupIds from the private link service resource.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State - Private endpoint connection state
- group
Ids List<String> - GroupIds from the private link service resource.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State - Private endpoint connection state
- group
Ids string[] - GroupIds from the private link service resource.
- private_
link_ service_ connection_ state This property is required. PrivateLink Service Connection State - Private endpoint connection state
- group_
ids Sequence[str] - GroupIds from the private link service resource.
- private
Link Service Connection State This property is required. Property Map - Private endpoint connection state
- group
Ids List<String> - GroupIds from the private link service resource.
PrivateEndpointConnectionPropertiesResponse, PrivateEndpointConnectionPropertiesResponseArgs
- Private
Link Service Connection State This property is required. Pulumi.Azure Native. Databricks. Inputs. Private Link Service Connection State Response - Private endpoint connection state
- Provisioning
State This property is required. string - Provisioning state of the private endpoint connection.
- Group
Ids List<string> - GroupIds from the private link service resource.
- Private
Endpoint Pulumi.Azure Native. Databricks. Inputs. Private Endpoint Response - Private endpoint
- Private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - Private endpoint connection state
- Provisioning
State This property is required. string - Provisioning state of the private endpoint connection.
- Group
Ids []string - GroupIds from the private link service resource.
- Private
Endpoint PrivateEndpoint Response - Private endpoint
- private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - Private endpoint connection state
- provisioning
State This property is required. String - Provisioning state of the private endpoint connection.
- group
Ids List<String> - GroupIds from the private link service resource.
- private
Endpoint PrivateEndpoint Response - Private endpoint
- private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - Private endpoint connection state
- provisioning
State This property is required. string - Provisioning state of the private endpoint connection.
- group
Ids string[] - GroupIds from the private link service resource.
- private
Endpoint PrivateEndpoint Response - Private endpoint
- private_
link_ service_ connection_ state This property is required. PrivateLink Service Connection State Response - 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 PrivateEndpoint Response - Private endpoint
- private
Link Service Connection State This property is required. Property Map - Private endpoint connection state
- provisioning
State This property is required. String - Provisioning state of the private endpoint connection.
- group
Ids List<String> - GroupIds from the private link service resource.
- private
Endpoint 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.Azure Native. Databricks. Private Link Service Connection Status - The status of a private endpoint connection
- Actions
Required 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 | PrivateLink Service Connection Status - The status of a private endpoint connection
- Actions
Required 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 | PrivateLink Service Connection Status - The status of a private endpoint connection
- actions
Required 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 | PrivateLink Service Connection Status - The status of a private endpoint connection
- actions
Required 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 | PrivateLink Service Connection Status - 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
- actions
Required 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
- Actions
Required 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
- Actions
Required 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
- actions
Required 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
- actions
Required 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
- actions
Required 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
- Private
Link Service Connection Status Pending - Pending
- Private
Link Service Connection Status Approved - Approved
- Private
Link Service Connection Status Rejected - Rejected
- Private
Link Service Connection Status 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
- "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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0