networks

Creates, updates, deletes, gets or lists a networks resource.

Overview

Name	networks
Type	Resource
Id	databricks_account.provisioning.networks

Fields

The following fields are returned by SELECT queries:

get

The network configuration was successfully returned.

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

list

The network configurations were successfully returned.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a Databricks network configuration, which represents an AWS VPC and its resources. This requires a pre-existing VPC and subnets.
list	select			Gets a list of all Databricks network configurations for an account, specified by ID.
create	insert			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			Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.

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

SELECT examples

get

Gets a Databricks network configuration, which represents an AWS VPC and its resources. This requires a pre-existing VPC and subnets.

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

list

Gets a list of all Databricks network configurations for an account, specified by ID.

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

INSERT examples

create

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

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

Manifest

# Description fields are for documentation purposes
- name: networks
  props:
    - name: network_name
      value: required
    - name: vpc_id
      value: string
    - name: subnet_ids
      value: string
    - name: security_group_ids
      value: Array of string
    - name: vpc_endpoints
      value: object

DELETE examples

delete

Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.

DELETE FROM databricks_account.provisioning.networks;