private_access

Operations on a private_access resource.

Overview

Name	private_access
Type	Resource
Id	databricks_account.provisioning.private_access

Fields

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

Methods

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

SELECT examples

private_access (list)

SELECT
account_id,
allowed_vpc_endpoint_ids,
private_access_level,
private_access_settings_id,
private_access_settings_name,
public_access_enabled,
region
FROM databricks_account.provisioning.private_access
WHERE account_id = '{{ account_id }}';

private_access (get)

SELECT
account_id,
allowed_vpc_endpoint_ids,
private_access_level,
private_access_settings_id,
private_access_settings_name,
public_access_enabled,
region
FROM databricks_account.provisioning.private_access
WHERE account_id = '{{ account_id }}' AND
private_access_settings_id = '{{ private_access_settings_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new private_access resource.

private_access

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

Manifest

- name: your_resource_model_name
  props:
  - name: private_access_settings_name
    value: string
  - name: region
    value: string
  - name: public_access_enabled
    value: false
  - name: private_access_level
    value: ENDPOINT
  - name: allowed_vpc_endpoint_ids
    value:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08

REPLACE example

Replaces a private_access resource.

/*+ update */
-- replace field1, field2, etc. with the fields you want to update
REPLACE databricks_account.provisioning.private_access
SET field1 = '{ value1 }',
field2 = '{ value2 }', ...
WHERE account_id = '{{ account_id }}' AND
private_access_settings_id = '{{ private_access_settings_id }}';

DELETE example

Deletes a private_access resource.

/*+ delete */
DELETE FROM databricks_account.provisioning.private_access
WHERE account_id = '{{ account_id }}' AND
private_access_settings_id = '{{ private_access_settings_id }}';