Compartilhar via


Comando configure

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. 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 configure command within the Databricks CLI enables you to authenticate the Databricks CLI with Azure Databricks using Azure Databricks personal access tokens or Microsoft Entra ID (formerly Azure Active Directory) tokens.

Note

As a security best practice, when you authenticate with automated tools, systems, scripts, and apps, Databricks recommends that you use personal access tokens belonging to service principals instead of workspace users. Para criar tokens para entidades de serviço, consulte Gerenciar tokens para uma entidade de serviço.

Note that this article covers only Azure Databricks personal access token and Microsoft Entra ID token authentication for enabling the calling of workspace-level commands. Para obter opções de configuração de autenticação adicionais, consulte Autenticação para a CLI do Databricks.

databricks configure

Configure um perfil no seu ~/.databrickscfg ficheiro. A configuration profile is a collection of settings that contains authentication information such as an Azure Databricks workspace URL and an access token value.

Um perfil de configuração tem um nome programático, como DEFAULT, DEVou PROD. Adicionar vários perfis ao .databrickscfg arquivo permite que você execute comandos rapidamente em vários espaços de trabalho, especificando o nome do perfil de conexão de destino na opção do --profile comando. Se você não especificar a --profile opção em um comando que ofereça suporte a essa opção, o comando usará o perfil de DEFAULT conexão por padrão.

Por exemplo, você pode ter um perfil de conexão chamado DEV que faça referência a um espaço de trabalho do Azure Databricks que você usa para cargas de trabalho de desenvolvimento e um perfil de conexão separado chamado PROD perfil de conexão que faça referência a um espaço de trabalho diferente do Azure Databricks que você usa para cargas de trabalho de produção.

Para obter informações sobre perfis de configuração existentes, use o grupo deauth comandos.

Você pode alterar o caminho padrão do arquivo definindo a variável DATABRICKS_CONFIG_FILEde .databrickscfg ambiente .

Se esse comando for invocado no modo não interativo, ele lerá o token do stdin. O host deve ser especificado com o sinalizador --host ou a DATABRICKS_HOST variável de ambiente.

databricks configure [flags]

Opções

--configure-cluster

    Solicitações para configurar o cluster

--host string

    URL do host do espaço de trabalho Databricks

A URL do host do espaço de trabalho é a URL por espaço de trabalho, com o formato https://adb-<workspace-id>.<random-number>.azuredatabricks.net. To get the per-workspace URL, see Per-workspace URL.

--profile string

    Nome do perfil de conexão a ser configurado. (default "DEFAULT")

Global flags

Examples

O exemplo a seguir configura a autenticação para o perfil padrão:

databricks configure

O exemplo a seguir configura a autenticação para um perfil específico:

databricks configure --profile my-profile

O exemplo a seguir configura a autenticação com um host específico:

databricks configure --host https://my-workspace.cloud.databricks.com

O exemplo a seguir configura a autenticação com configuração de cluster:

databricks configure --configure-cluster

Global flags

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

    Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

    Uma cadeia de caracteres que representa o arquivo para gravar logs de saída. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo text de formato de log ou json. O valor predefinido é text.

--log-level string

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

    O nome do perfil no ~/.databrickscfg arquivo a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

    Se aplicável, o destino do pacote a ser usado

Criar um perfil de configuração

Para criar um perfil de configuração, execute o configure comando:

databricks configure --host <workspace-url>

O comando solicita que o/a utilizador insira o seu token de acesso pessoal do Azure Databricks ou o token do Microsoft Entra ID (anteriormente Azure Active Directory) que corresponde ao especificado .

✔ Databricks Token:

Depois de inserir seu token de acesso, ele é armazenado no arquivo ~/.databrickscfg no Linux ou macOS, ou %USERPROFILE%\.databrickscfg no Windows por padrão. O arquivo contém uma entrada de perfil de conexão padrão chamada DEFAULT:

[DEFAULT]
host  = <workspace-url>
token = <access-token>

Para usar um nome diferente para seu perfil de conexão em vez de DEFAULT, adicione a --profile opção ao configure comando, por exemplo:

databricks configure --host <workspace-url> --profile <profile-name>

Tip

Você pode pressionar Tab após --profile ou -p para exibir uma lista de perfis de configuração disponíveis existentes para escolher, em vez de inserir o nome do perfil de configuração manualmente.

Todas as informações de host e token existentes dentro do perfil de conexão especificado são substituídas pelas novas informações de host e token.