workspace_settings_v2

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

Overview

Name	workspace_settings_v2
Type	Resource
Id	databricks_workspace.settingsv2.workspace_settings_v2

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Name of the setting.
▶aibi_dashboard_embedding_access_policy	object
▶aibi_dashboard_embedding_approved_domains	object	Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.
▶automatic_cluster_update_workspace	object	Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.
▶boolean_val	object	Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.
▶effective_aibi_dashboard_embedding_access_policy	object	Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.
▶effective_aibi_dashboard_embedding_approved_domains	object	Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.
▶effective_automatic_cluster_update_workspace	object	Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.
▶effective_boolean_val	object	Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.
▶effective_integer_val	object	Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.
▶effective_personal_compute	object	Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.
▶effective_restrict_workspace_admins	object	Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.
▶effective_string_val	object	Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.
▶integer_val	object	Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.
▶personal_compute	object	Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.
▶restrict_workspace_admins	object	Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.
▶string_val	object	Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.

list

Name	Datatype	Description
name	string	Name of the setting.
description	string
docs_link	string	Link to databricks documentation for the setting
type	string	Sample message depicting the type of the setting. To set this setting, the value sent must match this type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list
list	select	deployment_name	page_size, page_token	List valid setting keys and metadata. These settings are available to be referenced via GET
patch	update	name, deployment_name, setting		Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
name	string	Name of the setting
page_size	integer	The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 200 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string	A page token, received from a previous ListWorkspaceSettingsMetadataRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaceSettingsMetadataRequest must match the call that provided the page token.

SELECT examples

get

Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list

SELECT
name,
aibi_dashboard_embedding_access_policy,
aibi_dashboard_embedding_approved_domains,
automatic_cluster_update_workspace,
boolean_val,
effective_aibi_dashboard_embedding_access_policy,
effective_aibi_dashboard_embedding_approved_domains,
effective_automatic_cluster_update_workspace,
effective_boolean_val,
effective_integer_val,
effective_personal_compute,
effective_restrict_workspace_admins,
effective_string_val,
integer_val,
personal_compute,
restrict_workspace_admins,
string_val
FROM databricks_workspace.settingsv2.workspace_settings_v2
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

List valid setting keys and metadata. These settings are available to be referenced via GET

SELECT
name,
description,
docs_link,
type
FROM databricks_workspace.settingsv2.workspace_settings_v2
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

UPDATE examples

patch

Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for

UPDATE databricks_workspace.settingsv2.workspace_settings_v2
SET 
setting = '{{ setting }}'
WHERE 
name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND setting = '{{ setting }}' --required
RETURNING
name,
aibi_dashboard_embedding_access_policy,
aibi_dashboard_embedding_approved_domains,
automatic_cluster_update_workspace,
boolean_val,
effective_aibi_dashboard_embedding_access_policy,
effective_aibi_dashboard_embedding_approved_domains,
effective_automatic_cluster_update_workspace,
effective_boolean_val,
effective_integer_val,
effective_personal_compute,
effective_restrict_workspace_admins,
effective_string_val,
integer_val,
personal_compute,
restrict_workspace_admins,
string_val;