ip_access_lists

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

Overview

Name	ip_access_lists
Type	Resource
Id	databricks_workspace.settings.ip_access_lists

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶ip_access_list	object	Definition of an IP Access list

list

Name	Datatype	Description
list_id	string	Universally unique identifier (UUID) of the IP access list.
address_count	integer	Total number of IP or CIDR values.
created_at	integer	Creation timestamp in milliseconds.
created_by	integer	User ID of the user who created this list.
enabled	boolean	Specifies whether this IP access list is enabled.
ip_addresses	array
label	string	Label for the IP access list. This **cannot** be empty.
list_type	string	Type of IP access list. Valid values are as follows and are case-sensitive:<br /><br />* `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or<br />range. IP addresses in the block list are excluded even if they are included in an allow list. (ALLOW, BLOCK)
updated_at	integer	Update timestamp in milliseconds.
updated_by	integer	User ID of the user who updated this list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip_access_list_id, 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, label, list_type		Creates an IP access list for this workspace.
update	update	ip_access_list_id, deployment_name		Updates an existing IP access list, specified by its ID.
replace	replace	ip_access_list_id, deployment_name, label, list_type, enabled		Replaces an IP access list, specified by its ID.
delete	delete	ip_access_list_id, 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)
ip_access_list_id	string	The ID for the corresponding IP access list

SELECT examples

get

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

SELECT
ip_access_list
FROM databricks_workspace.settings.ip_access_lists
WHERE ip_access_list_id = '{{ ip_access_list_id }}' -- required
AND 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.settings.ip_access_lists
WHERE deployment_name = '{{ deployment_name }}' -- required
;

INSERT examples

create

Creates an IP access list for this workspace.

INSERT INTO databricks_workspace.settings.ip_access_lists (
label,
list_type,
ip_addresses,
deployment_name
)
SELECT 
'{{ label }}' /* required */,
'{{ list_type }}' /* required */,
'{{ ip_addresses }}',
'{{ deployment_name }}'
RETURNING
ip_access_list
;

Manifest

# Description fields are for documentation purposes
- name: ip_access_lists
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the ip_access_lists resource.
  - name: label
    value: "{{ label }}"
    description: |
      Label for the IP access list. This **cannot** be empty.
  - name: list_type
    value: "{{ list_type }}"
    description: |
      :param ip_addresses: List[str] (optional)
  - name: ip_addresses
    value:
      - "{{ ip_addresses }}"

UPDATE examples

update

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

UPDATE databricks_workspace.settings.ip_access_lists
SET 
enabled = {{ enabled }},
ip_addresses = '{{ ip_addresses }}',
label = '{{ label }}',
list_type = '{{ list_type }}'
WHERE 
ip_access_list_id = '{{ ip_access_list_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required;

REPLACE examples

replace

Replaces an IP access list, specified by its ID.

REPLACE databricks_workspace.settings.ip_access_lists
SET 
label = '{{ label }}',
list_type = '{{ list_type }}',
enabled = {{ enabled }},
ip_addresses = '{{ ip_addresses }}'
WHERE 
ip_access_list_id = '{{ ip_access_list_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND label = '{{ label }}' --required
AND list_type = '{{ list_type }}' --required
AND enabled = {{ enabled }} --required;

DELETE examples

delete

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

DELETE FROM databricks_workspace.settings.ip_access_lists
WHERE ip_access_list_id = '{{ ip_access_list_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;