Skip to main content

account endpoints command group

note

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

The account endpoints command group within the Databricks CLI contains commands to manage network connectivity endpoints for your Databricks account. These endpoints enable private connectivity between your network resources and Databricks services.

databricks account endpoints create-endpoint

Create a network endpoint for the Databricks account.

After creation, the endpoint is initially in the PENDING state. The Databricks endpoint service automatically reviews and approves the endpoint within a few minutes. Use the GET method to retrieve the latest endpoint state. An endpoint can be used only after it reaches the APPROVED state.

databricks account endpoints create-endpoint PARENT DISPLAY_NAME REGION [flags]

Arguments

PARENT

    The parent resource name of the account under which the endpoint is created. Format: accounts/{account_id}.

DISPLAY_NAME

    The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

REGION

    The cloud provider region where this endpoint is located.

Options

--json JSON

 Either inline JSON string or @path/to/file.json with request body.

Global flags

databricks account endpoints delete-endpoint

Delete a network endpoint from the Databricks account.

Deleting a network endpoint removes the endpoint configuration from Databricks. Depending on the endpoint type and use case, you may also need to delete corresponding network resources in your cloud provider account.

databricks account endpoints delete-endpoint NAME [flags]

Arguments

NAME

    The fully qualified resource name of the network endpoint to delete.

Options

Global flags

databricks account endpoints get-endpoint

Get a network endpoint.

databricks account endpoints get-endpoint NAME [flags]

Arguments

NAME

    The fully qualified resource name of the network endpoint.

Options

Global flags

databricks account endpoints list-endpoints

List all network endpoints for the Databricks account.

databricks account endpoints list-endpoints PARENT [flags]

Arguments

PARENT

    The parent resource name of the account to list endpoints for. Format: accounts/{account_id}.

Options

--limit int

 Maximum number of results to return.

--page-size int

 Maximum number of endpoints to return per page.

Global flags

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