Skip to main content

workspace_network_configuration

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

Overview​

Nameworkspace_network_configuration
TypeResource
Iddatabricks_account.settings.workspace_network_configuration

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
network_policy_idstring
workspace_idintegerThe workspace ID.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_workspace_network_option_rpcselectaccount_id, workspace_id, account_hostGets the network option for a workspace. Every workspace has exactly one network policy binding, with
update_workspace_network_option_rpcreplaceaccount_id, workspace_id, account_hostUpdates the network option for a workspace. This operation associates the workspace with the specified

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.

NameDatatypeDescription
account_hoststringThe 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_idstring
workspace_idintegerThe workspace ID.

SELECT examples​

Gets the network option for a workspace. Every workspace has exactly one network policy binding, with

SELECT
network_policy_id,
workspace_id
FROM databricks_account.settings.workspace_network_configuration
WHERE account_id = '{{ account_id }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

REPLACE examples​

Updates the network option for a workspace. This operation associates the workspace with the specified

REPLACE databricks_account.settings.workspace_network_configuration
SET
network_policy_id = '{{ network_policy_id }}',
workspace_id = {{ workspace_id }}
WHERE
account_id = '{{ account_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND account_host = '{{ account_host }}' --required
RETURNING
network_policy_id,
workspace_id;