workspace_config

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

Overview

Name	workspace_config
Type	Resource
Id	databricks_workspace.settings.workspace_config

Fields

The following fields are returned by SELECT queries:

get_workspace_config

Name	Datatype	Description
customReferences	string	Custom reference links displayed in the workspace help menu
enable-X-Frame-Options	string	Controls the X-Frame-Options HTTP header to prevent clickjacking by restricting iframe embedding
enableClusterAclsConfig	string	Enables cluster-level access control lists (ACLs) for managing cluster permissions
enableDatabricksAutologgingAdminConf	string	Enables or disables Databricks Autologging for MLflow experiments at the workspace level
enableDbfsFileBrowser	string	Enables the DBFS visual file browser in the workspace UI
enableDcs	string	Enables Delta Cache Service for accelerated data reads from cloud storage
enableDeprecatedGlobalInitScripts	string	Enables legacy global init scripts (deprecated in favor of the Global Init Scripts API)
enableEnforceImdsV2	string	Enforces IMDSv2 (Instance Metadata Service v2) on cluster nodes for improved security (AWS only)
enableExportNotebook	string	Controls whether users can export notebooks from the workspace
enableFileStoreEndpoint	string	Enables the /FileStore endpoint for accessing files uploaded to DBFS FileStore
enableGp3	string	Enables GP3 EBS volumes for cluster nodes instead of GP2 (AWS only)
enableHlsRuntime	string	Enables the Databricks Runtime for Health and Life Sciences (genomics and biomedical workloads)
enableIpAccessLists	string	Enables IP access list functionality to restrict workspace access by IP address (Premium tier required)
enableJobAclsConfig	string	Enables job-level access control lists (ACLs) for managing job permissions
enableJobsEmailsV2	string	Enables the updated email notification system for job run results
enableJobViewAcls	string	Enables view-level ACLs on jobs, restricting visibility of jobs to permitted users
enableNotebookTableClipboard	string	Controls whether users can copy table data from notebook output to the clipboard
enableProjectsAllowList	string	Enables the projects allow list to restrict which Git repositories can be used
enableProjectTypeInWorkspace	string	Enables project-type resources within the workspace
enableResultsDownloading	string	Controls whether users can download query and notebook results
enableTokensConfig	string	Enables or disables personal access token creation and management for the workspace
enableUploadDataUis	string	Enables the data upload UI for importing files into the workspace
enableVerboseAuditLogs	string	Enables verbose audit logging with additional event details including notebook command results
enableWebTerminal	string	Enables web-based terminal access to cluster driver nodes from the workspace UI
enableWorkspaceAclsConfig	string	Enables workspace-level access control lists (ACLs) for managing workspace object permissions
enableWorkspaceFilesystem	string	Enables the workspace filesystem for storing and accessing workspace files
enforceClusterViewAcls	string	Enforces view-level ACLs on clusters, restricting cluster visibility to permitted users
enforceUserIsolation	string	Enforces user isolation on clusters to prevent users from accessing each others data
enforceWorkspaceViewAcls	string	Enforces view-level ACLs on workspace objects, restricting visibility to permitted users
heapAnalyticsAdminConsent	string	Controls admin consent for Heap Analytics usage tracking in the workspace
homePageLogo	string	Custom logo image URL displayed on the workspace home page
homePageLogoWidth	string	Width in pixels of the custom home page logo
homePageWelcomeMessage	string	Custom welcome message displayed on the workspace home page
jobsListBackendPaginationEnabled	string	Enables backend pagination for the jobs list API for improved performance with large job counts
jobsListBackendPaginationOptOut	string	Opts out of backend pagination for the jobs list if enabled at the workspace level
loginLogo	string	Custom logo image URL displayed on the workspace login page
loginLogoWidth	string	Width in pixels of the custom login page logo
maxTokenLifetimeDays	string	Maximum lifetime in days for newly created personal access tokens (empty or 0 means no limit)
mlflowModelRegistryEmailNotificationsEnabled	string	Enables email notifications for MLflow Model Registry events such as model version transitions
mlflowModelServingEndpointCreationEnabled	string	Enables creation of MLflow model serving endpoints in the workspace
mlflowRunArtifactDownloadEnabled	string	Controls whether users can download artifacts from MLflow experiment runs
productName	string	Custom product name displayed in the workspace UI (white-labeling)
projectsAllowList	string	Comma-separated list of allowed Git repository URL prefixes for workspace projects
projectsAllowListPermissions	string	Permissions configuration for who can manage the projects allow list
reposIpynbResultsExportPermissions	string	Controls permissions for exporting ipynb notebook results from Git-backed repos
rStudioUserDefaultHomeBase	string	Default home directory base path for RStudio users in the workspace
sidebarLogoActive	string	Custom logo image URL for the active state of the workspace sidebar
sidebarLogoInactive	string	Custom logo image URL for the inactive state of the workspace sidebar
sidebarLogoText	string	Custom text displayed alongside the sidebar logo (white-labeling)
storeInteractiveNotebookResultsInCustomerAccount	string	Stores all interactive notebook results in the customer cloud account instead of the Databricks control plane

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workspace_config	select	keys, deployment_name		Gets the configuration status for a workspace.
set_workspace_config	update	deployment_name, contents		Sets the configuration status for a workspace, including enabling or disabling it.

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)
keys	string	:returns: Dict[str,str]

SELECT examples

get_workspace_config

Gets the configuration status for a workspace.

SELECT
customReferences,
enable-X-Frame-Options,
enableClusterAclsConfig,
enableDatabricksAutologgingAdminConf,
enableDbfsFileBrowser,
enableDcs,
enableDeprecatedGlobalInitScripts,
enableEnforceImdsV2,
enableExportNotebook,
enableFileStoreEndpoint,
enableGp3,
enableHlsRuntime,
enableIpAccessLists,
enableJobAclsConfig,
enableJobViewAcls,
enableJobsEmailsV2,
enableNotebookTableClipboard,
enableProjectTypeInWorkspace,
enableProjectsAllowList,
enableResultsDownloading,
enableTokensConfig,
enableUploadDataUis,
enableVerboseAuditLogs,
enableWebTerminal,
enableWorkspaceAclsConfig,
enableWorkspaceFilesystem,
enforceClusterViewAcls,
enforceUserIsolation,
enforceWorkspaceViewAcls,
heapAnalyticsAdminConsent,
homePageLogo,
homePageLogoWidth,
homePageWelcomeMessage,
jobsListBackendPaginationEnabled,
jobsListBackendPaginationOptOut,
loginLogo,
loginLogoWidth,
maxTokenLifetimeDays,
mlflowModelRegistryEmailNotificationsEnabled,
mlflowModelServingEndpointCreationEnabled,
mlflowRunArtifactDownloadEnabled,
productName,
projectsAllowList,
projectsAllowListPermissions,
rStudioUserDefaultHomeBase,
reposIpynbResultsExportPermissions,
sidebarLogoActive,
sidebarLogoInactive,
sidebarLogoText,
storeInteractiveNotebookResultsInCustomerAccount
FROM databricks_workspace.settings.workspace_config
WHERE keys = '{{ keys }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

UPDATE examples

set_workspace_config

Sets the configuration status for a workspace, including enabling or disabling it.

UPDATE databricks_workspace.settings.workspace_config
SET 
contents = '{{ contents }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
AND contents = '{{ contents }}' --required;