Share via


git-credentials 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 git-credentials command group within the Databricks CLI allows you to register personal access tokens for Databricks to do Git operations on behalf of the user. See Get access tokens from Git provider.

databricks git-credentials create

Create a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the update command to update existing credentials, or the delete command to delete existing credentials.

databricks git-credentials create GIT_PROVIDER [flags]

Arguments

GIT_PROVIDER

    Git provider. This field is case-insensitive. The available Git providers are gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise, bitbucketServer, gitLabEnterpriseEdition and awsCodeCommit.

Options

--git-username string

    The username or email provided with your Git provider account, depending on which provider you are using.

--json JSON

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

--personal-access-token string

    The personal access token used to authenticate to the corresponding Git provider.

Global flags

databricks git-credentials delete

Delete the specified Git credential.

databricks git-credentials delete CREDENTIAL_ID [flags]

Arguments

CREDENTIAL_ID

    The ID for the corresponding credential to access.

Options

Global flags

databricks git-credentials get

Get the Git credentials with the specified credential ID.

databricks git-credentials get CREDENTIAL_ID [flags]

Arguments

CREDENTIAL_ID

    The ID for the corresponding credential to access.

Options

Global flags

databricks git-credentials list

List the calling user's Git credentials.

databricks git-credentials list [flags]

Options

Global flags

databricks git-credentials update

Update the specified Git credential.

databricks git-credentials update CREDENTIAL_ID GIT_PROVIDER [flags]

Arguments

CREDENTIAL_ID

    The ID for the corresponding credential to access.

GIT_PROVIDER

    Git provider. This field is case-insensitive. The available Git providers are gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise, bitbucketServer, gitLabEnterpriseEdition and awsCodeCommit.

Options

--git-username string

    The username or email provided with your Git provider account, depending on which provider you are using.

--json JSON

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

--personal-access-token string

    The personal access token used to authenticate to the corresponding Git provider.

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