networks

Operations on a networks resource.

Overview

Name	networks
Type	Resource
Id	databricks_account.provisioning.networks

Fields

Name	Datatype
account_id	string
creation_time	integer
error_messages	array
network_id	string
network_name	string
security_group_ids	array
subnet_ids	array
vpc_endpoints	object
vpc_id	string
vpc_status	string
warning_messages	array
workspace_id	integer

Methods

Name	Accessible by	Required Params	Description
get	SELECT	account_id, network_id	Gets a Databricks network configuration, which represents an AWS VPC and its resources. This requires a pre-existing VPC and subnets.
list	SELECT	account_id	Gets a list of all Databricks network configurations for an account, specified by ID.
create	INSERT	account_id	Creates a Databricks network configuration that represents an AWS VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets. For VPC requirements, see
delete	DELETE	account_id, network_id	Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.

SELECT examples

networks (list)

SELECT
account_id,
creation_time,
error_messages,
network_id,
network_name,
security_group_ids,
subnet_ids,
vpc_endpoints,
vpc_id,
vpc_status,
warning_messages,
workspace_id
FROM databricks_account.provisioning.networks
WHERE account_id = '{{ account_id }}';

networks (get)

SELECT
account_id,
creation_time,
error_messages,
network_id,
network_name,
security_group_ids,
subnet_ids,
vpc_endpoints,
vpc_id,
vpc_status,
warning_messages,
workspace_id
FROM databricks_account.provisioning.networks
WHERE account_id = '{{ account_id }}' AND
network_id = '{{ network_id }}';

INSERT example

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

networks

/*+ create */
INSERT INTO databricks_account.provisioning.networks (
account_id,
data__network_name,
data__vpc_id,
data__subnet_ids,
data__security_group_ids,
data__vpc_endpoints
)
SELECT 
'{{ account_id }}',
'{{ network_name }}',
'{{ vpc_id }}',
'{{ subnet_ids }}',
'{{ security_group_ids }}',
'{{ vpc_endpoints }}'
;

Manifest

- name: your_resource_model_name
  props:
  - name: network_name
    value: string
  - name: vpc_id
    value: string
  - name: subnet_ids
    value:
    - string
  - name: security_group_ids
    value:
    - string
  - name: vpc_endpoints
    value:
      rest_api:
      - 497f6eca-6276-4993-bfeb-53cbbbba6f08
      dataplane_relay:
      - 497f6eca-6276-4993-bfeb-53cbbbba6f08

DELETE example

Deletes a networks resource.

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