workspace-settings-v2 command group

Note

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The workspace-settings-v2 command group within the Databricks CLI allows you to manage workspace level settings.

databricks workspace-settings-v2 get-public-workspace-setting

Get a workspace setting value. See list-workspace-settings-metadata for a list of settings available via public APIs.

databricks workspace-settings-v2 get-public-workspace-setting NAME [flags]

Arguments

NAME

    Name of the setting.

Options

Global flags

Examples

The following example gets a workspace setting:

databricks workspace-settings-v2 get-public-workspace-setting my-setting-name

databricks workspace-settings-v2 list-workspace-settings-metadata

List valid setting keys and their metadata. These settings are available to be referenced via get-public-workspace-setting and patch-public-workspace-setting.

databricks workspace-settings-v2 list-workspace-settings-metadata [flags]

Arguments

None

Options

--page-size int

    The maximum number of settings to return.

--page-token string

    A page token, received from a previous list-workspace-settings-metadata call.

Global flags

Examples

The following example lists workspace settings metadata:

databricks workspace-settings-v2 list-workspace-settings-metadata

databricks workspace-settings-v2 patch-public-workspace-setting

Update a workspace setting value. See list-workspace-settings-metadata for a list of settings available via public APIs. To determine the correct field to include in a patch request, refer to the type field of the setting returned by list-workspace-settings-metadata. Note: Page refresh is required for changes to take effect in the UI.

databricks workspace-settings-v2 patch-public-workspace-setting NAME [flags]

Arguments

NAME

    Name of the setting.

Options

--json JSON

    The inline JSON string or the @path to the JSON file with the request body.

--name string

    Name of the setting.

Global flags

Examples

The following example updates a workspace setting using a JSON file:

databricks workspace-settings-v2 patch-public-workspace-setting my-setting-name --json @setting.json

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