account settings-v2 command group
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
The account settings-v2 command group within the Databricks CLI contains commands to manage account level settings and user preferences.
databricks account settings-v2 get-public-account-setting
This feature is in Public Preview.
Get an account setting.
This command gets a setting value at account level. See list-account-settings-metadata for the list of settings available via public APIs at account level.
databricks account settings-v2 get-public-account-setting NAME [flags]
Arguments
NAME
The name of the account setting to retrieve.
Options
databricks account settings-v2 get-public-account-user-preference
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Get a user preference.
This command gets a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See list-account-user-preferences-metadata for the list of user preferences available via public APIs.
databricks account settings-v2 get-public-account-user-preference USER_ID NAME [flags]
Arguments
USER_ID
User ID of the user whose setting is being retrieved.
NAME
User Setting name.
Options
databricks account settings-v2 list-account-settings-metadata
This feature is in Public Preview.
List valid setting keys and their metadata.
This command lists valid setting keys and metadata. These settings are available to be referenced via get-public-account-setting and patch-public-account-setting APIs.
databricks account settings-v2 list-account-settings-metadata [flags]
Options
--limit int
Maximum number of results to return.
--page-size int
The maximum number of settings to return.
databricks account settings-v2 list-account-user-preferences-metadata
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
List user preferences and their metadata.
This command lists valid user preferences and their metadata for a specific user. User preferences are personal settings that allow individual customization without affecting other users. These settings are available to be referenced via get-public-account-user-preference and patch-public-account-user-preference APIs.
databricks account settings-v2 list-account-user-preferences-metadata USER_ID [flags]
Arguments
USER_ID
User ID of the user whose settings metadata is being retrieved.
Options
--limit int
Maximum number of results to return.
--page-size int
The maximum number of settings to return.
databricks account settings-v2 patch-public-account-setting
This feature is in Public Preview.
Update an account setting.
This command patches a setting value at account level. See list-account-settings-metadata for the list of settings available via public APIs at account level. To determine the correct field to include in a patch request, refer to the type field of the setting returned in the list-account-settings-metadata response. Page refresh is required for changes to take effect in UI.
databricks account settings-v2 patch-public-account-setting NAME [flags]
Arguments
NAME
The name of the account setting.
Options
--json JSON
Either inline JSON string or @path/to/file.json with request body.
--name string
Name of the setting.
databricks account settings-v2 patch-public-account-user-preference
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Update a user preference.
This command updates a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See list-account-user-preferences-metadata for the list of user preferences available via public APIs. Page refresh is required for changes to take effect in UI.
databricks account settings-v2 patch-public-account-user-preference USER_ID NAME [flags]
Arguments
USER_ID
User ID of the user whose setting is being updated.
NAME
Setting name.
Options
--json JSON
Either inline JSON string or @path/to/file.json with request body.
--name string
Name of the setting.
--user-id string
User ID of the user.
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use