account storage 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 storage command group within the Databricks CLI contains commands to manage storage configurations for workspaces. A root storage S3 bucket in your account is required to store objects like cluster logs, notebook revisions, and job results. You can also use the root storage S3 bucket for storage of non-production DBFS data. A storage configuration encapsulates this bucket information, and its ID is used when creating a new workspace.

databricks account storage create

Create a Databricks storage configuration for an account.

databricks account storage create [flags]

Options

--role-arn string

    Optional IAM role that is used to access the workspace catalog which is created during workspace creation for Unity Catalog by default.

--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 storage configuration using JSON:

databricks account storage create --json '{"storage_configuration_name": "my-storage-config", "root_bucket_info": {"bucket_name": "my-databricks-bucket"}}'

The following example creates a storage configuration with an IAM role:

databricks account storage create --role-arn "arn:aws:iam::123456789012:role/my-uc-role" --json '{"storage_configuration_name": "my-storage-config", "root_bucket_info": {"bucket_name": "my-databricks-bucket"}}'

The following example creates a storage configuration using a JSON file:

databricks account storage create --json @storage-config.json

databricks account storage delete

Delete a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace.

databricks account storage delete STORAGE_CONFIGURATION_ID [flags]

Arguments

STORAGE_CONFIGURATION_ID

    Databricks storage configuration ID.

Options

Global flags

Examples

The following example deletes a storage configuration by ID:

databricks account storage delete storage-abc123

databricks account storage get

Get a Databricks storage configuration for an account, specified by ID.

databricks account storage get STORAGE_CONFIGURATION_ID [flags]

Arguments

STORAGE_CONFIGURATION_ID

    Databricks storage configuration ID.

Options

Global flags

Examples

The following example gets a storage configuration by ID:

databricks account storage get storage-abc123

databricks account storage list

List Databricks storage configurations for an account.

databricks account storage list [flags]

Options

Global flags

Examples

The following example lists all storage configurations:

databricks account storage list

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