1. Packages
  2. Databricks Provider
  3. API Docs
  4. getEndpoints
Viewing docs for Databricks v1.88.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getEndpoints

databricks logo
Viewing docs for Databricks v1.88.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    Endpoints datasource retrieves a list of all network connectivity endpoints 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 listing endpoints in Azure cloud:

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    variables:
  all:
    fn::invoke:
      function: databricks:getEndpoints
      arguments:
        accountId: eae3abf6-1496-494e-9983-4660a5ad5aab

    Using getEndpoints

    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 getEndpoints(args: GetEndpointsArgs, opts?: InvokeOptions): Promise<GetEndpointsResult>
function getEndpointsOutput(args: GetEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEndpointsResult>
    def get_endpoints(page_size: Optional[int] = None,
                  parent: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEndpointsResult
def get_endpoints_output(page_size: Optional[pulumi.Input[int]] = None,
                  parent: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEndpointsResult]
    func GetEndpoints(ctx *Context, args *GetEndpointsArgs, opts ...InvokeOption) (*GetEndpointsResult, error)
func GetEndpointsOutput(ctx *Context, args *GetEndpointsOutputArgs, opts ...InvokeOption) GetEndpointsResultOutput

    > Note: This function is named GetEndpoints in the Go SDK.

    public static class GetEndpoints 
{
    public static Task<GetEndpointsResult> InvokeAsync(GetEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointsResult> Invoke(GetEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
public static Output<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getEndpoints:getEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Parent string
    PageSize int
    Parent string
    PageSize int
    parent String
    pageSize Integer
    parent string
    pageSize number
    parent String
    pageSize Number

    getEndpoints Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetEndpointsItem>
    Parent string
    PageSize int
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetEndpointsItem
    Parent string
    PageSize int
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetEndpointsItem>
    parent String
    pageSize Integer
    id string
    The provider-assigned unique ID for this managed resource.
    items GetEndpointsItem[]
    parent string
    pageSize number
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetEndpointsItem]
    parent str
    page_size int
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    parent String
    pageSize Number

    Supporting Types

    GetEndpointsItem

    AccountId string
    (string) - The Databricks Account in which the endpoint object exists
    AzurePrivateEndpointInfo GetEndpointsItemAzurePrivateEndpointInfo
    (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
    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 GetEndpointsItemAzurePrivateEndpointInfo
    (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
    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 GetEndpointsItemAzurePrivateEndpointInfo
    (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
    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 GetEndpointsItemAzurePrivateEndpointInfo
    (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
    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 GetEndpointsItemAzurePrivateEndpointInfo
    (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
    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
    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

    GetEndpointsItemAzurePrivateEndpointInfo

    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.
    databricks logo
    Viewing docs for Databricks v1.88.0
    published on Thursday, Feb 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.