1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getEndpoint
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

    GA

    API Documentation

    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 dictionary
    data "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:

    AccountId string
    (string) - The Databricks Account in which the endpoint object exists
    AwsVpcEndpointInfo GetEndpointAwsVpcEndpointInfo
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    GcpPscEndpointInfo GetEndpointGcpPscEndpointInfo
    (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
    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
    AwsVpcEndpointInfo GetEndpointAwsVpcEndpointInfo
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    GcpPscEndpointInfo GetEndpointGcpPscEndpointInfo
    (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
    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 string
    (string) - The Databricks Account in which the endpoint object exists
    aws_vpc_endpoint_info object
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    azure_private_endpoint_info object
    (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_endpoint_info object
    (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
    accountId String
    (string) - The Databricks Account in which the endpoint object exists
    awsVpcEndpointInfo GetEndpointAwsVpcEndpointInfo
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    gcpPscEndpointInfo GetEndpointGcpPscEndpointInfo
    (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
    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
    awsVpcEndpointInfo GetEndpointAwsVpcEndpointInfo
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    gcpPscEndpointInfo GetEndpointGcpPscEndpointInfo
    (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
    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
    aws_vpc_endpoint_info GetEndpointAwsVpcEndpointInfo
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    gcp_psc_endpoint_info GetEndpointGcpPscEndpointInfo
    (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
    accountId String
    (string) - The Databricks Account in which the endpoint object exists
    awsVpcEndpointInfo Property Map
    (AwsVpcEndpointInfo) - Info for an AWS VPC endpoint
    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
    gcpPscEndpointInfo Property Map
    (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
    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

    GetEndpointAwsVpcEndpointInfo

    AwsAccountId string
    (string) - The AWS account ID in which this VPC endpoint lives
    AwsEndpointServiceId string
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    AwsVpcEndpointId string
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    AwsAccountId string
    (string) - The AWS account ID in which this VPC endpoint lives
    AwsEndpointServiceId string
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    AwsVpcEndpointId string
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    aws_account_id string
    (string) - The AWS account ID in which this VPC endpoint lives
    aws_endpoint_service_id string
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    aws_vpc_endpoint_id string
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    awsAccountId String
    (string) - The AWS account ID in which this VPC endpoint lives
    awsEndpointServiceId String
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    awsVpcEndpointId String
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    awsAccountId string
    (string) - The AWS account ID in which this VPC endpoint lives
    awsEndpointServiceId string
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    awsVpcEndpointId string
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    aws_account_id str
    (string) - The AWS account ID in which this VPC endpoint lives
    aws_endpoint_service_id str
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    aws_vpc_endpoint_id str
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint
    awsAccountId String
    (string) - The AWS account ID in which this VPC endpoint lives
    awsEndpointServiceId String
    (string) - The ID of the Databricks VPC endpoint service that this endpoint connects to
    awsVpcEndpointId String
    (string) - The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint

    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
    private_endpoint_name string
    (string) - The name of the Private Endpoint in the Azure subscription
    private_endpoint_resource_guid 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
    private_endpoint_resource_id string
    (string) - The full resource ID of the Private Endpoint
    private_link_service_id 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

    GetEndpointGcpPscEndpointInfo

    EndpointRegion 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
    ProjectId string
    (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
    PscConnectionId string
    (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
    PscEndpoint string
    (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
    ServiceAttachmentId string
    (string) - The ID of the Databricks service attachment this PSC endpoint connects to
    EndpointRegion 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
    ProjectId string
    (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
    PscConnectionId string
    (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
    PscEndpoint string
    (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
    ServiceAttachmentId string
    (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_id string
    (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_id string
    (string) - The ID of the Databricks service attachment this PSC endpoint connects to
    endpointRegion 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
    projectId String
    (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
    pscConnectionId String
    (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
    pscEndpoint String
    (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
    serviceAttachmentId String
    (string) - The ID of the Databricks service attachment this PSC endpoint connects to
    endpointRegion 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
    projectId string
    (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
    pscConnectionId string
    (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
    pscEndpoint string
    (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
    serviceAttachmentId string
    (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_id str
    (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_id str
    (string) - The ID of the Databricks service attachment this PSC endpoint connects to
    endpointRegion 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
    projectId String
    (string) - The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint
    pscConnectionId String
    (string) - The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created
    pscEndpoint String
    (string) - The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint
    serviceAttachmentId String
    (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 databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.101.0
    published on Thursday, Jul 30, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial