private_access

Creates, updates, deletes, gets or lists a private_access resource.

Overview

Name	private_access
Type	Resource
Id	databricks_account.provisioning.private_access

Fields

The following fields are returned by SELECT queries:

get

The private access settings object was successfully returned.

Name	Datatype	Description
account_id	string
private_access_settings_id	string
private_access_settings_name	string
allowed_vpc_endpoint_ids	array
private_access_level	string
public_access_enabled	boolean
region	string

list

The private access settings object was successfully returned.

Name	Datatype	Description
account_id	string
private_access_settings_id	string
private_access_settings_name	string
allowed_vpc_endpoint_ids	array
private_access_level	string
public_access_enabled	boolean
region	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a private access settings object, which specifies how your workspace is accessed over
list	select			Gets a list of all private access settings objects for an account, specified by ID.
create	insert			Creates a private access settings object, which specifies how your workspace is accessed over
replace	replace			Updates an existing private access settings object, which specifies how your workspace is accessed over
delete	delete			Deletes a private access settings object, which determines how your workspace is accessed over

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

SELECT examples

get

Gets a private access settings object, which specifies how your workspace is accessed over

SELECT
account_id,
private_access_settings_id,
private_access_settings_name,
allowed_vpc_endpoint_ids,
private_access_level,
public_access_enabled,
region
FROM databricks_account.provisioning.private_access;

list

Gets a list of all private access settings objects for an account, specified by ID.

SELECT
account_id,
private_access_settings_id,
private_access_settings_name,
allowed_vpc_endpoint_ids,
private_access_level,
public_access_enabled,
region
FROM databricks_account.provisioning.private_access;

INSERT examples

create

Creates a private access settings object, which specifies how your workspace is accessed over

INSERT INTO databricks_account.provisioning.private_access (
data__private_access_settings_name,
data__region,
data__public_access_enabled,
data__private_access_level,
data__allowed_vpc_endpoint_ids
)
SELECT 
'{{ private_access_settings_name }}',
'{{ region }}',
'{{ public_access_enabled }}',
'{{ private_access_level }}',
{{ allowed_vpc_endpoint_ids }}
RETURNING
account_id,
private_access_settings_id,
private_access_settings_name,
allowed_vpc_endpoint_ids,
private_access_level,
public_access_enabled,
region
;

Manifest

# Description fields are for documentation purposes
- name: private_access
  props:
    - name: private_access_settings_name
      value: required
    - name: region
      value: string
    - name: public_access_enabled
      value: required
    - name: private_access_level
      value: string
    - name: allowed_vpc_endpoint_ids
      value: boolean

REPLACE examples

replace

Updates an existing private access settings object, which specifies how your workspace is accessed over

REPLACE databricks_account.provisioning.private_access
SET 
data__private_access_settings_name = '{{ private_access_settings_name }}',
data__region = '{{ region }}',
data__public_access_enabled = '{{ public_access_enabled }}',
data__private_access_level = '{{ private_access_level }}',
data__allowed_vpc_endpoint_ids = {{ allowed_vpc_endpoint_ids }}
WHERE 
;

DELETE examples

delete

Deletes a private access settings object, which determines how your workspace is accessed over

DELETE FROM databricks_account.provisioning.private_access;