network_connectivity

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

Overview

Name	network_connectivity
Type	Resource
Id	databricks_account.settings.network_connectivity

Fields

The following fields are returned by SELECT queries:

get_network_connectivity_configuration

Name	Datatype	Description
name	string	The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression ^[0-9a-zA-Z-_]{3,30}$
account_id	string	Your Databricks account ID. You can find your account ID in your Databricks accounts console.
network_connectivity_config_id	string	Databricks network connectivity configuration ID.
creation_time	integer	Time in epoch milliseconds when this object was created.
▶egress_config	object	The network connectivity rules that apply to network traffic from your serverless compute resources.
region	string	The region for the network connectivity configuration. Only workspaces in the same region can be attached to the network connectivity configuration.
updated_time	integer	Time in epoch milliseconds when this object was updated.

list_network_connectivity_configurations

Name	Datatype	Description
name	string	The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression ^[0-9a-zA-Z-_]{3,30}$
account_id	string	Your Databricks account ID. You can find your account ID in your Databricks accounts console.
network_connectivity_config_id	string	Databricks network connectivity configuration ID.
creation_time	integer	Time in epoch milliseconds when this object was created.
▶egress_config	object	The network connectivity rules that apply to network traffic from your serverless compute resources.
region	string	The region for the network connectivity configuration. Only workspaces in the same region can be attached to the network connectivity configuration.
updated_time	integer	Time in epoch milliseconds when this object was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_connectivity_configuration	select	account_id, network_connectivity_config_id		Gets a network connectivity configuration.
list_network_connectivity_configurations	select	account_id	page_token	Gets an array of network connectivity configurations.
create_network_connectivity_configuration	insert	account_id, network_connectivity_config		Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when
delete_network_connectivity_configuration	delete	account_id, network_connectivity_config_id		Deletes a network connectivity configuration.

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_id	string
network_connectivity_config_id	string	Your Network Connectivity Configuration ID.
page_token	string	Pagination token to go to next page based on previous query.

SELECT examples

get_network_connectivity_configuration

Gets a network connectivity configuration.

SELECT
name,
account_id,
network_connectivity_config_id,
creation_time,
egress_config,
region,
updated_time
FROM databricks_account.settings.network_connectivity
WHERE account_id = '{{ account_id }}' -- required
AND network_connectivity_config_id = '{{ network_connectivity_config_id }}' -- required
;

list_network_connectivity_configurations

Gets an array of network connectivity configurations.

SELECT
name,
account_id,
network_connectivity_config_id,
creation_time,
egress_config,
region,
updated_time
FROM databricks_account.settings.network_connectivity
WHERE account_id = '{{ account_id }}' -- required
AND page_token = '{{ page_token }}'
;

INSERT examples

create_network_connectivity_configuration

Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when

INSERT INTO databricks_account.settings.network_connectivity (
network_connectivity_config,
account_id
)
SELECT 
'{{ network_connectivity_config }}' /* required */,
'{{ account_id }}'
RETURNING
name,
account_id,
network_connectivity_config_id,
creation_time,
egress_config,
region,
updated_time
;

Manifest

# Description fields are for documentation purposes
- name: network_connectivity
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the network_connectivity resource.
  - name: network_connectivity_config
    description: |
      Properties of the new network connectivity configuration.
    value:
      name: "{{ name }}"
      region: "{{ region }}"

DELETE examples

delete_network_connectivity_configuration

Deletes a network connectivity configuration.

DELETE FROM databricks_account.settings.network_connectivity
WHERE account_id = '{{ account_id }}' --required
AND network_connectivity_config_id = '{{ network_connectivity_config_id }}' --required
;