endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	databricks_account.networking.endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The resource name of the endpoint, which uniquely identifies the endpoint.
account_id	string	The Databricks Account in which the endpoint object exists.
endpoint_id	string	The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.
display_name	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.
▶aws_vpc_endpoint_info	object	Info for an AWS VPC endpoint.
▶azure_private_endpoint_info	object	Info for an Azure private endpoint.
create_time	string (date-time)	The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.
▶gcp_psc_endpoint_info	object	Info for a GCP Private Service Connect endpoint.
region	string	The cloud provider region where this endpoint is located.
state	string	The state of the endpoint. The endpoint can only be used if the state is ``APPROVED``. (APPROVED, DISCONNECTED, FAILED, PENDING)
use_case	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. (SERVICE_DIRECT)

list

Name	Datatype	Description
name	string	The resource name of the endpoint, which uniquely identifies the endpoint.
account_id	string	The Databricks Account in which the endpoint object exists.
endpoint_id	string	The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.
display_name	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.
▶aws_vpc_endpoint_info	object	Info for an AWS VPC endpoint.
▶azure_private_endpoint_info	object	Info for an Azure private endpoint.
create_time	string (date-time)	The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.
▶gcp_psc_endpoint_info	object	Info for a GCP Private Service Connect endpoint.
region	string	The cloud provider region where this endpoint is located.
state	string	The state of the endpoint. The endpoint can only be used if the state is ``APPROVED``. (APPROVED, DISCONNECTED, FAILED, PENDING)
use_case	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. (SERVICE_DIRECT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, endpoint_id, account_host		Gets details of a specific network endpoint.
list	select	account_id, account_host	page_size, page_token	Lists all network connectivity endpoints for the account.
create	insert	account_id, account_host, display_name, region		Creates a new network connectivity endpoint that enables private connectivity between your network
delete	delete	account_id, endpoint_id, account_host		Deletes a network endpoint. This will remove the endpoint configuration from Databricks. Depending on

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string	The account_id segment of the name resource name (accounts/{account_id}/endpoints/{endpoint_id}).
endpoint_id	string	The endpoint_id segment of the name resource name (accounts/{account_id}/endpoints/{endpoint_id}).
page_size	integer
page_token	string

SELECT examples

get

Gets details of a specific network endpoint.

SELECT
name,
account_id,
endpoint_id,
display_name,
aws_vpc_endpoint_info,
azure_private_endpoint_info,
create_time,
gcp_psc_endpoint_info,
region,
state,
use_case
FROM databricks_account.networking.endpoints
WHERE account_id = '{{ account_id }}' -- required
AND endpoint_id = '{{ endpoint_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

list

Lists all network connectivity endpoints for the account.

SELECT
name,
account_id,
endpoint_id,
display_name,
aws_vpc_endpoint_info,
azure_private_endpoint_info,
create_time,
gcp_psc_endpoint_info,
region,
state,
use_case
FROM databricks_account.networking.endpoints
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new network connectivity endpoint that enables private connectivity between your network

INSERT INTO databricks_account.networking.endpoints (
display_name,
region,
account_id,
aws_vpc_endpoint_info,
azure_private_endpoint_info,
create_time,
endpoint_id,
gcp_psc_endpoint_info,
name,
state,
use_case,
account_id,
account_host
)
SELECT 
'{{ display_name }}' /* required */,
'{{ region }}' /* required */,
'{{ account_id }}',
'{{ aws_vpc_endpoint_info }}',
'{{ azure_private_endpoint_info }}',
'{{ create_time }}',
'{{ endpoint_id }}',
'{{ gcp_psc_endpoint_info }}',
'{{ name }}',
'{{ state }}',
'{{ use_case }}',
'{{ account_id }}',
'{{ account_host }}'
RETURNING
name,
account_id,
endpoint_id,
display_name,
aws_vpc_endpoint_info,
azure_private_endpoint_info,
create_time,
gcp_psc_endpoint_info,
region,
state,
use_case
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the endpoints resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the endpoints resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      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.
  - name: region
    value: "{{ region }}"
    description: |
      The cloud provider region where this endpoint is located.
  - name: account_id
    value: "{{ account_id }}"
    description: |
      The Databricks Account in which the endpoint object exists.
  - name: aws_vpc_endpoint_info
    description: |
      Info for an AWS VPC endpoint.
    value:
      aws_vpc_endpoint_id: "{{ aws_vpc_endpoint_id }}"
      aws_account_id: "{{ aws_account_id }}"
      aws_endpoint_service_id: "{{ aws_endpoint_service_id }}"
  - name: azure_private_endpoint_info
    description: |
      Info for an Azure private endpoint.
    value:
      private_endpoint_name: "{{ private_endpoint_name }}"
      private_endpoint_resource_guid: "{{ private_endpoint_resource_guid }}"
      private_endpoint_resource_id: "{{ private_endpoint_resource_id }}"
      private_link_service_id: "{{ private_link_service_id }}"
  - name: create_time
    value: "{{ create_time }}"
    description: |
      The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.
  - name: endpoint_id
    value: "{{ endpoint_id }}"
    description: |
      The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.
  - name: gcp_psc_endpoint_info
    description: |
      Info for a GCP Private Service Connect endpoint.
    value:
      project_id: "{{ project_id }}"
      psc_endpoint: "{{ psc_endpoint }}"
      endpoint_region: "{{ endpoint_region }}"
      psc_connection_id: "{{ psc_connection_id }}"
      service_attachment_id: "{{ service_attachment_id }}"
  - name: name
    value: "{{ name }}"
    description: |
      The resource name of the endpoint, which uniquely identifies the endpoint.
  - name: state
    value: "{{ state }}"
    description: |
      The state of the endpoint. The endpoint can only be used if the state is ``APPROVED``.
  - name: use_case
    value: "{{ use_case }}"
    description: |
      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.

DELETE examples

delete

Deletes a network endpoint. This will remove the endpoint configuration from Databricks. Depending on

DELETE FROM databricks_account.networking.endpoints
WHERE account_id = '{{ account_id }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND account_host = '{{ account_host }}' --required
;