account_settings

Creates, updates, deletes, gets or lists an account_settings resource.

Overview

Name	account_settings
Type	Resource
Id	databricks_account.settingsv2.account_settings

Fields

The following fields are returned by SELECT queries:

get_public_account_setting

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.
▶allowed_apps_user_api_scopes	object	Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes 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.
▶collaboration_platform_connectivity	object	Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity 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_allowed_apps_user_api_scopes	object	Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.
▶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_collaboration_platform_connectivity	object	Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.
▶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_operational_email_custom_recipient	object	Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.
▶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.
▶effective_workspace_label	object	Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.
▶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.
▶operational_email_custom_recipient	object	Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient 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.
▶workspace_label	object	Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.

list_account_settings_metadata

Name	Datatype	Description
name	string	Name of the setting.
display_name	string	Human-readable display name for the setting or feature preview. This field may be unset if no display name is available.
description	string
docs_link	string	Link to databricks documentation for the setting
preview_phase	string	Preview phase for feature preview settings. This field is not set for non-preview settings. (BETA, GA, GA_SOON, PRIVATE_PREVIEW, PUBLIC_PREVIEW)
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_public_account_setting	select	account_id, name, account_host		Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of
list_account_settings_metadata	select	account_id, account_host	page_size, page_token	List valid setting keys and metadata. These settings are available to be referenced via GET
patch_public_account_setting	update	account_id, name, account_host		Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of

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_host	string	The 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_id	string
name	string
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 ListAccountSettingsMetadataRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountSettingsMetadataRequest must match the call that provided the page token.

SELECT examples

get_public_account_setting

Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of

SELECT
name,
aibi_dashboard_embedding_access_policy,
aibi_dashboard_embedding_approved_domains,
allowed_apps_user_api_scopes,
automatic_cluster_update_workspace,
boolean_val,
collaboration_platform_connectivity,
effective_aibi_dashboard_embedding_access_policy,
effective_aibi_dashboard_embedding_approved_domains,
effective_allowed_apps_user_api_scopes,
effective_automatic_cluster_update_workspace,
effective_boolean_val,
effective_collaboration_platform_connectivity,
effective_integer_val,
effective_operational_email_custom_recipient,
effective_personal_compute,
effective_restrict_workspace_admins,
effective_string_val,
effective_workspace_label,
integer_val,
operational_email_custom_recipient,
personal_compute,
restrict_workspace_admins,
string_val,
workspace_label
FROM databricks_account.settingsv2.account_settings
WHERE account_id = '{{ account_id }}' -- required
AND name = '{{ name }}' -- required
AND account_host = '{{ account_host }}' -- required
;

list_account_settings_metadata

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

SELECT
name,
display_name,
description,
docs_link,
preview_phase,
type
FROM databricks_account.settingsv2.account_settings
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

UPDATE examples

patch_public_account_setting

Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of

UPDATE databricks_account.settingsv2.account_settings
SET 
aibi_dashboard_embedding_access_policy = '{{ aibi_dashboard_embedding_access_policy }}',
aibi_dashboard_embedding_approved_domains = '{{ aibi_dashboard_embedding_approved_domains }}',
allowed_apps_user_api_scopes = '{{ allowed_apps_user_api_scopes }}',
automatic_cluster_update_workspace = '{{ automatic_cluster_update_workspace }}',
boolean_val = '{{ boolean_val }}',
collaboration_platform_connectivity = '{{ collaboration_platform_connectivity }}',
effective_aibi_dashboard_embedding_access_policy = '{{ effective_aibi_dashboard_embedding_access_policy }}',
effective_aibi_dashboard_embedding_approved_domains = '{{ effective_aibi_dashboard_embedding_approved_domains }}',
effective_allowed_apps_user_api_scopes = '{{ effective_allowed_apps_user_api_scopes }}',
effective_automatic_cluster_update_workspace = '{{ effective_automatic_cluster_update_workspace }}',
effective_boolean_val = '{{ effective_boolean_val }}',
effective_collaboration_platform_connectivity = '{{ effective_collaboration_platform_connectivity }}',
effective_integer_val = '{{ effective_integer_val }}',
effective_operational_email_custom_recipient = '{{ effective_operational_email_custom_recipient }}',
effective_personal_compute = '{{ effective_personal_compute }}',
effective_restrict_workspace_admins = '{{ effective_restrict_workspace_admins }}',
effective_string_val = '{{ effective_string_val }}',
effective_workspace_label = '{{ effective_workspace_label }}',
integer_val = '{{ integer_val }}',
name = '{{ name }}',
operational_email_custom_recipient = '{{ operational_email_custom_recipient }}',
personal_compute = '{{ personal_compute }}',
restrict_workspace_admins = '{{ restrict_workspace_admins }}',
string_val = '{{ string_val }}',
workspace_label = '{{ workspace_label }}'
WHERE 
account_id = '{{ account_id }}' --required
AND name = '{{ name }}' --required
AND account_host = '{{ account_host }}' --required
RETURNING
name,
aibi_dashboard_embedding_access_policy,
aibi_dashboard_embedding_approved_domains,
allowed_apps_user_api_scopes,
automatic_cluster_update_workspace,
boolean_val,
collaboration_platform_connectivity,
effective_aibi_dashboard_embedding_access_policy,
effective_aibi_dashboard_embedding_approved_domains,
effective_allowed_apps_user_api_scopes,
effective_automatic_cluster_update_workspace,
effective_boolean_val,
effective_collaboration_platform_connectivity,
effective_integer_val,
effective_operational_email_custom_recipient,
effective_personal_compute,
effective_restrict_workspace_admins,
effective_string_val,
effective_workspace_label,
integer_val,
operational_email_custom_recipient,
personal_compute,
restrict_workspace_admins,
string_val,
workspace_label;