Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi
Endpoint datasource retrieves information about a single network connectivity endpoint for private access to Databricks workspaces.
Note This resource can only be used with an account-level provider!
Example Usage
Example for Azure cloud
This is an example for getting an endpoint in Azure cloud:
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
variables:
this:
fn::invoke:
function: databricks:getEndpoint
arguments:
parent: accounts/123e4567-e89b-12d3-a456-426614174000
endpointId: endpoint-123
pulumi {
required_providers {
databricks = {
source = "pulumi/databricks"
}
}
}
data "databricks_getendpoint" "this" {
parent = "accounts/123e4567-e89b-12d3-a456-426614174000"
endpoint_id = "endpoint-123"
}
Using getEndpoint
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>def get_endpoint(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput> Note: This function is named LookupEndpoint in the Go SDK.
public static class GetEndpoint
{
public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getEndpoint:getEndpoint
arguments:
# arguments dictionarydata "databricks_get_endpoint" "name" {
# arguments
}The following arguments are supported:
- Name string
- The resource name of the endpoint, which uniquely identifies the endpoint
- Name string
- The resource name of the endpoint, which uniquely identifies the endpoint
- name string
- The resource name of the endpoint, which uniquely identifies the endpoint
- name String
- The resource name of the endpoint, which uniquely identifies the endpoint
- name string
- The resource name of the endpoint, which uniquely identifies the endpoint
- name str
- The resource name of the endpoint, which uniquely identifies the endpoint
- name String
- The resource name of the endpoint, which uniquely identifies the endpoint
getEndpoint Result
The following output properties are available:
- Account
Id string - (string) - The Databricks Account in which the endpoint object exists
- Aws
Vpc GetEndpoint Info Endpoint Aws Vpc Endpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- Azure
Private GetEndpoint Info Endpoint Azure Private Endpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- Create
Time string - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- Display
Name string - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- Endpoint
Id string - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- Gcp
Psc GetEndpoint Info Endpoint Gcp Psc Endpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- Name string
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- Region string
- (string) - The cloud provider region where this endpoint is located
- State string
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - Use
Case string - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- Account
Id string - (string) - The Databricks Account in which the endpoint object exists
- Aws
Vpc GetEndpoint Info Endpoint Aws Vpc Endpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- Azure
Private GetEndpoint Info Endpoint Azure Private Endpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- Create
Time string - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- Display
Name string - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- Endpoint
Id string - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- Gcp
Psc GetEndpoint Info Endpoint Gcp Psc Endpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- Name string
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- Region string
- (string) - The cloud provider region where this endpoint is located
- State string
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - Use
Case string - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- account_
id string - (string) - The Databricks Account in which the endpoint object exists
- aws_
vpc_ objectendpoint_ info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- azure_
private_ objectendpoint_ info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- create_
time string - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- display_
name string - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- endpoint_
id string - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- gcp_
psc_ objectendpoint_ info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- name string
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- region string
- (string) - The cloud provider region where this endpoint is located
- state string
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - use_
case string - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- account
Id String - (string) - The Databricks Account in which the endpoint object exists
- aws
Vpc GetEndpoint Info Endpoint Aws Vpc Endpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- azure
Private GetEndpoint Info Endpoint Azure Private Endpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- create
Time String - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- display
Name String - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- endpoint
Id String - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- gcp
Psc GetEndpoint Info Endpoint Gcp Psc Endpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- name String
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- region String
- (string) - The cloud provider region where this endpoint is located
- state String
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - use
Case String - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- account
Id string - (string) - The Databricks Account in which the endpoint object exists
- aws
Vpc GetEndpoint Info Endpoint Aws Vpc Endpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- azure
Private GetEndpoint Info Endpoint Azure Private Endpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- create
Time string - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- display
Name string - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- endpoint
Id string - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- gcp
Psc GetEndpoint Info Endpoint Gcp Psc Endpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- name string
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- region string
- (string) - The cloud provider region where this endpoint is located
- state string
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - use
Case string - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- account_
id str - (string) - The Databricks Account in which the endpoint object exists
- aws_
vpc_ Getendpoint_ info Endpoint Aws Vpc Endpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- azure_
private_ Getendpoint_ info Endpoint Azure Private Endpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- create_
time str - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- display_
name str - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- endpoint_
id str - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- gcp_
psc_ Getendpoint_ info Endpoint Gcp Psc Endpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- name str
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- region str
- (string) - The cloud provider region where this endpoint is located
- state str
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - use_
case str - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
- account
Id String - (string) - The Databricks Account in which the endpoint object exists
- aws
Vpc Property MapEndpoint Info - (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
- azure
Private Property MapEndpoint Info - (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
- create
Time String - (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
- display
Name String - (string) - The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum
- endpoint
Id String - (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
- gcp
Psc Property MapEndpoint Info - (GcpPscEndpointInfo) - Info for a GCP Private Service Connect endpoint
- name String
- (string) - The resource name of the endpoint, which uniquely identifies the endpoint
- region String
- (string) - The cloud provider region where this endpoint is located
- state String
- (string) - The state of the endpoint. The endpoint can only be used if the state is
APPROVED. Possible values are:APPROVED,DISCONNECTED,FAILED,PENDING - use
Case String - (string) - The use case that determines the type of network connectivity this endpoint provides.
This field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are:
SERVICE_DIRECT
Supporting Types
GetEndpointAwsVpcEndpointInfo
- Aws
Account stringId - (string) - The AWS account ID in which this VPC endpoint lives
- Aws
Endpoint stringService Id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- Aws
Vpc stringEndpoint Id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- Aws
Account stringId - (string) - The AWS account ID in which this VPC endpoint lives
- Aws
Endpoint stringService Id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- Aws
Vpc stringEndpoint Id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- aws_
account_ stringid - (string) - The AWS account ID in which this VPC endpoint lives
- aws_
endpoint_ stringservice_ id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- aws_
vpc_ stringendpoint_ id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- aws
Account StringId - (string) - The AWS account ID in which this VPC endpoint lives
- aws
Endpoint StringService Id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- aws
Vpc StringEndpoint Id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- aws
Account stringId - (string) - The AWS account ID in which this VPC endpoint lives
- aws
Endpoint stringService Id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- aws
Vpc stringEndpoint Id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- aws_
account_ strid - (string) - The AWS account ID in which this VPC endpoint lives
- aws_
endpoint_ strservice_ id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- aws_
vpc_ strendpoint_ id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
- aws
Account StringId - (string) - The AWS account ID in which this VPC endpoint lives
- aws
Endpoint StringService Id - (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
- aws
Vpc StringEndpoint Id - (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
GetEndpointAzurePrivateEndpointInfo
- Private
Endpoint stringName - (string) - The name of the Private Endpoint in the Azure subscription
- Private
Endpoint stringResource Guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- Private
Endpoint stringResource Id - (string) - The full resource ID of the Private Endpoint
- Private
Link stringService Id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- Private
Endpoint stringName - (string) - The name of the Private Endpoint in the Azure subscription
- Private
Endpoint stringResource Guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- Private
Endpoint stringResource Id - (string) - The full resource ID of the Private Endpoint
- Private
Link stringService Id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- private_
endpoint_ stringname - (string) - The name of the Private Endpoint in the Azure subscription
- private_
endpoint_ stringresource_ guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- private_
endpoint_ stringresource_ id - (string) - The full resource ID of the Private Endpoint
- private_
link_ stringservice_ id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- private
Endpoint StringName - (string) - The name of the Private Endpoint in the Azure subscription
- private
Endpoint StringResource Guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- private
Endpoint StringResource Id - (string) - The full resource ID of the Private Endpoint
- private
Link StringService Id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- private
Endpoint stringName - (string) - The name of the Private Endpoint in the Azure subscription
- private
Endpoint stringResource Guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- private
Endpoint stringResource Id - (string) - The full resource ID of the Private Endpoint
- private
Link stringService Id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- private_
endpoint_ strname - (string) - The name of the Private Endpoint in the Azure subscription
- private_
endpoint_ strresource_ guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- private_
endpoint_ strresource_ id - (string) - The full resource ID of the Private Endpoint
- private_
link_ strservice_ id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
- private
Endpoint StringName - (string) - The name of the Private Endpoint in the Azure subscription
- private
Endpoint StringResource Guid - (string) - The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint
- private
Endpoint StringResource Id - (string) - The full resource ID of the Private Endpoint
- private
Link StringService Id - (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to
GetEndpointGcpPscEndpointInfo
- Endpoint
Region string - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- Project
Id string - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- Psc
Connection stringId - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- Psc
Endpoint string - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- Service
Attachment stringId - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- Endpoint
Region string - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- Project
Id string - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- Psc
Connection stringId - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- Psc
Endpoint string - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- Service
Attachment stringId - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- endpoint_
region string - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- project_
id string - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- psc_
connection_ stringid - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- psc_
endpoint string - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- service_
attachment_ stringid - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- endpoint
Region String - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- project
Id String - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- psc
Connection StringId - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- psc
Endpoint String - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- service
Attachment StringId - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- endpoint
Region string - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- project
Id string - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- psc
Connection stringId - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- psc
Endpoint string - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- service
Attachment stringId - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- endpoint_
region str - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- project_
id str - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- psc_
connection_ strid - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- psc_
endpoint str - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- service_
attachment_ strid - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
- endpoint
Region String - (string) - The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region
- project
Id String - (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
- psc
Connection StringId - (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
- psc
Endpoint String - (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
- service
Attachment StringId - (string) - The ID of the Databricks service attachment this PSC endpoint connects to
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi