แชร์ผ่าน


account private-access 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 private-access command group within the Databricks CLI contains commands to manage private access settings for your account. Private access settings represent network access restrictions for workspace resources and configure whether workspaces can be accessed from the public internet or only from private endpoints using AWS PrivateLink.

databricks account private-access create

Create a private access settings configuration, which represents network access restrictions for workspace resources. Private access settings configure whether workspaces can be accessed from the public internet or only from private endpoints.

databricks account private-access create [flags]

Options

--private-access-level PrivateAccessLevel

    The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: ACCOUNT, ENDPOINT.

--private-access-settings-name string

    The human-readable name of the private access settings object.

--public-access-enabled

    Determines if the workspace can be accessed over public internet.

--region string

    The AWS region for workspaces attached to this private access settings object.

--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 private access settings configuration using command-line flags:

databricks account private-access create --private-access-settings-name "my-private-access" --region "us-west-2" --private-access-level ACCOUNT

The following example creates a private access settings configuration using JSON:

databricks account private-access create --json '{"private_access_settings_name": "my-private-access", "region": "us-west-2", "private_access_level": "ACCOUNT", "public_access_enabled": false}'

The following example creates a private access settings configuration using a JSON file:

databricks account private-access create --json @private-access-settings.json

databricks account private-access delete

Delete a Databricks private access settings configuration, specified by ID.

databricks account private-access delete PRIVATE_ACCESS_SETTINGS_ID [flags]

Arguments

PRIVATE_ACCESS_SETTINGS_ID

    Databricks private access settings ID.

Options

Global flags

Examples

The following example deletes a private access settings configuration by ID:

databricks account private-access delete pas-abc123

databricks account private-access get

Get a Databricks private access settings configuration, specified by ID.

databricks account private-access get PRIVATE_ACCESS_SETTINGS_ID [flags]

Arguments

PRIVATE_ACCESS_SETTINGS_ID

    Databricks private access settings ID.

Options

Global flags

Examples

The following example gets a private access settings configuration by ID:

databricks account private-access get pas-abc123

databricks account private-access list

List Databricks private access settings for an account.

databricks account private-access list [flags]

Options

Global flags

Examples

The following example lists all private access settings:

databricks account private-access list

databricks account private-access replace

Update an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change.

Important

If public_access_enabled, private_access_level, or allowed_vpc_endpoint_ids are updated, effects of these changes might take several minutes to propagate to the workspace API. You can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.

databricks account private-access replace PRIVATE_ACCESS_SETTINGS_ID [flags]

Arguments

PRIVATE_ACCESS_SETTINGS_ID

    Databricks private access settings ID.

Options

--private-access-level PrivateAccessLevel

    The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: ACCOUNT, ENDPOINT.

--private-access-settings-name string

    The human-readable name of the private access settings object.

--public-access-enabled

    Determines if the workspace can be accessed over public internet.

--region string

    The AWS region for workspaces attached to this private access settings object.

--json JSON

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

Global flags

Examples

The following example replaces a private access settings configuration using command-line flags:

databricks account private-access replace pas-abc123 --private-access-settings-name "updated-private-access" --region "us-west-2" --private-access-level ENDPOINT

The following example replaces a private access settings configuration using JSON:

databricks account private-access replace pas-abc123 --json '{"private_access_settings_name": "updated-private-access", "region": "us-west-2", "private_access_level": "ENDPOINT", "public_access_enabled": false, "allowed_vpc_endpoint_ids": ["vpce-12345678"]}'

The following example replaces a private access settings configuration using a JSON file:

databricks account private-access replace pas-abc123 --json @replace-private-access-settings.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