account workspace-network-configuration 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 workspace-network-configuration command group within the Databricks CLI contains commands to configure network settings for Databricks workspaces by selecting which network policy to associate with the workspace.

databricks account workspace-network-configuration get-workspace-network-option-rpc

Get the network option for a workspace. Every workspace has exactly one network policy binding, with default-policy used if no explicit assignment exists.

databricks account workspace-network-configuration get-workspace-network-option-rpc WORKSPACE_ID [flags]

Arguments

WORKSPACE_ID

    The workspace ID.

Options

Global flags

Examples

The following example gets the network option for a workspace:

databricks account workspace-network-configuration get-workspace-network-option-rpc 123456789

databricks account workspace-network-configuration update-workspace-network-option-rpc

Update the network option for a workspace. This operation associates the workspace with the specified network policy. To revert to the default policy, specify default-policy as the network_policy_id.

databricks account workspace-network-configuration update-workspace-network-option-rpc WORKSPACE_ID [flags]

Arguments

WORKSPACE_ID

    The workspace ID.

Options

--network-policy-id string

    The network policy ID to apply to the workspace.

--workspace-id int

    The workspace ID.

--json JSON

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

Global flags

Examples

The following example updates a workspace to use a specific network policy:

databricks account workspace-network-configuration update-workspace-network-option-rpc 123456789 --network-policy-id "my-network-policy"

The following example reverts a workspace to the default network policy:

databricks account workspace-network-configuration update-workspace-network-option-rpc 123456789 --network-policy-id "default-policy"

The following example updates a workspace network option using JSON:

databricks account workspace-network-configuration update-workspace-network-option-rpc 123456789 --json '{"network_policy_id": "my-network-policy"}'

The following example updates a workspace network option using a JSON file:

databricks account workspace-network-configuration update-workspace-network-option-rpc 123456789 --json @workspace-network-config.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