account_ip_access_lists

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

Overview

Name	account_ip_access_lists
Type	Resource
Id	databricks_account.settings.account_ip_access_lists

Fields

The following fields are returned by SELECT queries:

account_ip_access_lists_get

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.<br />- ``BLOCK``: A block list. Exclude this IP or range. IP addresses in the block list are excluded<br /> 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.

account_ip_access_lists_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.<br />- ``BLOCK``: A block list. Exclude this IP or range. IP addresses in the block list are excluded<br /> 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
account_ip_access_lists_get	select	account_id, ip_access_list_id, account_host		Gets an IP access list, specified by its list ID.
account_ip_access_lists_list	select	account_id, account_host		Gets all IP access lists for the specified account.
account_ip_access_lists_create	insert	account_id, account_host, label, list_type		Creates an IP access list for the account.
account_ip_access_lists_update	update	account_id, ip_access_list_id, account_host		Updates an existing IP access list, specified by its ID.
account_ip_access_lists_replace	replace	account_id, ip_access_list_id, account_host, label, list_type, enabled		Replaces an IP access list, specified by its ID.
account_ip_access_lists_delete	delete	account_id, ip_access_list_id, account_host		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
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
ip_access_list_id	string	The ID for the corresponding IP access list

SELECT examples

account_ip_access_lists_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_account.settings.account_ip_access_lists
WHERE account_id = '{{ account_id }}' -- required
AND ip_access_list_id = '{{ ip_access_list_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

account_ip_access_lists_list

Gets all IP access lists for the specified account.

SELECT
list_id,
address_count,
created_at,
created_by,
enabled,
ip_addresses,
label,
list_type,
updated_at,
updated_by
FROM databricks_account.settings.account_ip_access_lists
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

INSERT examples

account_ip_access_lists_create

Creates an IP access list for the account.

INSERT INTO databricks_account.settings.account_ip_access_lists (
label,
list_type,
ip_addresses,
account_id,
account_host
)
SELECT 
'{{ label }}' /* required */,
'{{ list_type }}' /* required */,
'{{ ip_addresses }}',
'{{ account_id }}',
'{{ account_host }}'
RETURNING
ip_access_list
;

Manifest

# Description fields are for documentation purposes
- name: account_ip_access_lists
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the account_ip_access_lists resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the account_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: |
      Type of IP access list. Valid values are as follows and are case-sensitive:
      - ``ALLOW``: An allow list. Include this IP or range.
      - ``BLOCK``: A block list. Exclude this IP or range. IP addresses in the block list are excluded
      even if they are included in an allow list.
  - name: ip_addresses
    value:
      - "{{ ip_addresses }}"

UPDATE examples

account_ip_access_lists_update

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

UPDATE databricks_account.settings.account_ip_access_lists
SET 
enabled = {{ enabled }},
ip_addresses = '{{ ip_addresses }}',
label = '{{ label }}',
list_type = '{{ list_type }}'
WHERE 
account_id = '{{ account_id }}' --required
AND ip_access_list_id = '{{ ip_access_list_id }}' --required
AND account_host = '{{ account_host }}' --required;

REPLACE examples

account_ip_access_lists_replace

Replaces an IP access list, specified by its ID.

REPLACE databricks_account.settings.account_ip_access_lists
SET 
label = '{{ label }}',
list_type = '{{ list_type }}',
enabled = {{ enabled }},
ip_addresses = '{{ ip_addresses }}'
WHERE 
account_id = '{{ account_id }}' --required
AND ip_access_list_id = '{{ ip_access_list_id }}' --required
AND account_host = '{{ account_host }}' --required
AND label = '{{ label }}' --required
AND list_type = '{{ list_type }}' --required
AND enabled = {{ enabled }} --required;

DELETE examples

account_ip_access_lists_delete

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

DELETE FROM databricks_account.settings.account_ip_access_lists
WHERE account_id = '{{ account_id }}' --required
AND ip_access_list_id = '{{ ip_access_list_id }}' --required
AND account_host = '{{ account_host }}' --required
;