getEndpoint

Databricks v1.88.0, Feb 26 26

Viewing docs for Databricks v1.88.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.88.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

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:
        accountId: eae3abf6-1496-494e-9983-4660a5ad5aab
        endpointId: 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: Optional[pulumi.Input[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 dictionary

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 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:

AccountId string: (string) - The Databricks Account in which the endpoint object exists
AzurePrivateEndpointInfo GetEndpointAzurePrivateEndpointInfo: (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
CreateTime string: (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
DisplayName 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
EndpointId string: (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
Id string: The provider-assigned unique ID for this managed resource.
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
UseCase 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

AccountId string: (string) - The Databricks Account in which the endpoint object exists
AzurePrivateEndpointInfo GetEndpointAzurePrivateEndpointInfo: (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
CreateTime string: (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
DisplayName 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
EndpointId string: (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
Id string: The provider-assigned unique ID for this managed resource.
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
UseCase 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

accountId String: (string) - The Databricks Account in which the endpoint object exists
azurePrivateEndpointInfo GetEndpointAzurePrivateEndpointInfo: (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
createTime String: (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
displayName 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
endpointId String: (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
id String: The provider-assigned unique ID for this managed resource.
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
useCase 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

accountId string: (string) - The Databricks Account in which the endpoint object exists
azurePrivateEndpointInfo GetEndpointAzurePrivateEndpointInfo: (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
createTime string: (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
displayName 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
endpointId string: (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
id string: The provider-assigned unique ID for this managed resource.
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
useCase 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
azure_private_endpoint_info GetEndpointAzurePrivateEndpointInfo: (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
id str: The provider-assigned unique ID for this managed resource.
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

accountId String: (string) - The Databricks Account in which the endpoint object exists
azurePrivateEndpointInfo Property Map: (AzurePrivateEndpointInfo) - Info for an Azure private endpoint
createTime String: (string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone
displayName 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
endpointId String: (string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks
id String: The provider-assigned unique ID for this managed resource.
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
useCase 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

GetEndpointAzurePrivateEndpointInfo

PrivateEndpointName string: (string) - The name of the Private Endpoint in the Azure subscription
PrivateEndpointResourceGuid string: (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
PrivateEndpointResourceId string: (string) - The full resource ID of the Private Endpoint
PrivateLinkServiceId string: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

PrivateEndpointName string: (string) - The name of the Private Endpoint in the Azure subscription
PrivateEndpointResourceGuid string: (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
PrivateEndpointResourceId string: (string) - The full resource ID of the Private Endpoint
PrivateLinkServiceId string: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

privateEndpointName String: (string) - The name of the Private Endpoint in the Azure subscription
privateEndpointResourceGuid String: (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
privateEndpointResourceId String: (string) - The full resource ID of the Private Endpoint
privateLinkServiceId String: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

privateEndpointName string: (string) - The name of the Private Endpoint in the Azure subscription
privateEndpointResourceGuid string: (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
privateEndpointResourceId string: (string) - The full resource ID of the Private Endpoint
privateLinkServiceId string: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

private_endpoint_name str: (string) - The name of the Private Endpoint in the Azure subscription
private_endpoint_resource_guid str: (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_resource_id str: (string) - The full resource ID of the Private Endpoint
private_link_service_id str: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

privateEndpointName String: (string) - The name of the Private Endpoint in the Azure subscription
privateEndpointResourceGuid String: (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
privateEndpointResourceId String: (string) - The full resource ID of the Private Endpoint
privateLinkServiceId String: (string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v1.88.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

databricks.getEndpoint

On this page

On this page

Example Usage

Example for Azure cloud

Using getEndpoint

getEndpoint Result

Supporting Types

GetEndpointAzurePrivateEndpointInfo

Package Details

On this page

On this page