account usage-dashboards command group

Note

This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.

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

The account usage-dashboards command group within the Databricks CLI contains commands to manage usage dashboards for your account. Usage dashboards enable you to gain insights into your usage with pre-built dashboards: visualize breakdowns, analyze tag attributions, and identify cost drivers. See Usage dashboards.

databricks account usage-dashboards create

Create a usage dashboard specified by workspace ID, account ID, and dashboard type.

databricks account usage-dashboards create [flags]

Options

--dashboard-type UsageDashboardType

    Type of usage dashboard. Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE.

--workspace-id int

    The workspace ID of the workspace in which the usage dashboard is created.

--major-version UsageDashboardMajorVersion

    The major version of the usage dashboard template to use. Supported values: USAGE_DASHBOARD_MAJOR_VERSION_1, USAGE_DASHBOARD_MAJOR_VERSION_2.

--json JSON

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

Global flags

Examples

The following example creates a global usage dashboard:

databricks account usage-dashboards create --dashboard-type USAGE_DASHBOARD_TYPE_GLOBAL --workspace-id 123456789

The following example creates a workspace-level usage dashboard with a specific version:

databricks account usage-dashboards create --dashboard-type USAGE_DASHBOARD_TYPE_WORKSPACE --workspace-id 123456789 --major-version USAGE_DASHBOARD_MAJOR_VERSION_2

The following example creates a usage dashboard using JSON:

databricks account usage-dashboards create --json '{"dashboard_type": "USAGE_DASHBOARD_TYPE_GLOBAL", "workspace_id": 123456789, "major_version": "USAGE_DASHBOARD_MAJOR_VERSION_2"}'

The following example creates a usage dashboard using a JSON file:

databricks account usage-dashboards create --json @usage-dashboard.json

databricks account usage-dashboards get

Get a usage dashboard specified by workspace ID, account ID, and dashboard type.

databricks account usage-dashboards get [flags]

Options

--dashboard-type UsageDashboardType

    Type of usage dashboard. Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE.

--workspace-id int

    The workspace ID of the workspace in which the usage dashboard is created.

Global flags

Examples

The following example gets a global usage dashboard:

databricks account usage-dashboards get --dashboard-type USAGE_DASHBOARD_TYPE_GLOBAL --workspace-id 123456789

The following example gets a workspace-level usage dashboard:

databricks account usage-dashboards get --dashboard-type USAGE_DASHBOARD_TYPE_WORKSPACE --workspace-id 123456789

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