Share via


account networks 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 networks command group within the Databricks CLI contains commands to manage network configurations for customer-managed VPCs. A network configuration represents a VPC and its resources. Its ID is used when creating a new workspace if you use customer-managed VPCs.

databricks account networks create

Create a Databricks network configuration that represents a VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets.

databricks account networks create [flags]

Options

--network-name string

    The human-readable name of the network configuration.

--vpc-id string

    The ID of the VPC associated with this network configuration.

--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 network configuration using command-line flags:

databricks account networks create --network-name "my-vpc-config" --vpc-id "vpc-12345678"

The following example creates a network configuration using JSON:

databricks account networks create --json '{"network_name": "my-vpc-config", "vpc_id": "vpc-12345678", "subnet_ids": ["subnet-11111111", "subnet-22222222"], "security_group_ids": ["sg-33333333"]}'

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

databricks account networks create --json @network-config.json

databricks account networks delete

Delete a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.

Note

This operation is available only if your account is on the E2 version of the platform.

databricks account networks delete NETWORK_ID [flags]

Arguments

NETWORK_ID

    Databricks Account API network configuration ID.

Options

Global flags

Examples

The following example deletes a network configuration by ID:

databricks account networks delete net-abc123

databricks account networks get

Get a Databricks network configuration, which represents a cloud VPC and its resources.

databricks account networks get NETWORK_ID [flags]

Arguments

NETWORK_ID

    Databricks Account API network configuration ID.

Options

Global flags

Examples

The following example gets a network configuration by ID:

databricks account networks get net-abc123

databricks account networks list

List Databricks network configurations for an account.

databricks account networks list [flags]

Options

Global flags

Examples

The following example lists all network configurations:

databricks account networks 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