ip_access_lists

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

Overview

Name	ip_access_lists
Type	Resource
Id	databricks_workspace.workspace.ip_access_lists

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully.

Name	Datatype	Description
list_id	string
address_count	integer
created_at	integer
created_by	integer
enabled	boolean
ip_addresses	array
label	string
list_type	string
updated_at	integer
updated_by	integer

list

Request completed successfully.

Name	Datatype	Description
list_id	string
address_count	integer
created_at	integer
created_by	integer
enabled	boolean
ip_addresses	array
label	string
list_type	string
updated_at	integer
updated_by	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets an IP access list, specified by its list ID.
list	select	deployment_name		Gets all IP access lists for the specified workspace.
create	insert	deployment_name		Creates an IP access list for this workspace.
update	update	deployment_name		Updates an existing IP access list, specified by its ID.
replace	replace	deployment_name		Replaces an IP access list, specified by its ID.
delete	delete	deployment_name		Deletes an IP access list, specified by its list ID.

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

get

Gets an IP access list, specified by its list ID.

SELECT
list_id,
address_count,
created_at,
created_by,
enabled,
ip_addresses,
label,
list_type,
updated_at,
updated_by
FROM databricks_workspace.workspace.ip_access_lists
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets all IP access lists for the specified workspace.

SELECT
list_id,
address_count,
created_at,
created_by,
enabled,
ip_addresses,
label,
list_type,
updated_at,
updated_by
FROM databricks_workspace.workspace.ip_access_lists
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates an IP access list for this workspace.

INSERT INTO databricks_workspace.workspace.ip_access_lists (
data__label,
data__list_type,
data__ip_addresses,
deployment_name
)
SELECT 
'{{ label }}',
'{{ list_type }}',
'{{ ip_addresses }}',
'{{ deployment_name }}'
RETURNING
ip_access_list
;

Manifest

# Description fields are for documentation purposes
- name: ip_access_lists
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the ip_access_lists resource.
    - name: label
      value: required
    - name: list_type
      value: string
    - name: ip_addresses
      value: required

UPDATE examples

update

Updates an existing IP access list, specified by its ID.

UPDATE databricks_workspace.workspace.ip_access_lists
SET 
data__label = '{{ label }}',
data__list_type = '{{ list_type }}',
data__ip_addresses = '{{ ip_addresses }}',
data__enabled = {{ enabled }}
WHERE 
deployment_name = '{{ deployment_name }}' --required;

REPLACE examples

replace

Replaces an IP access list, specified by its ID.

REPLACE databricks_workspace.workspace.ip_access_lists
SET 
data__label = '{{ label }}',
data__list_type = '{{ list_type }}',
data__ip_addresses = '{{ ip_addresses }}',
data__enabled = '{{ enabled }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

delete

Deletes an IP access list, specified by its list ID.

DELETE FROM databricks_workspace.workspace.ip_access_lists
WHERE deployment_name = '{{ deployment_name }}' --required;