Grupo de comandos configure

Observação

Essas informações se aplicam às versões da CLI do Databricks 0.205 e superiores, que estão em Versão Prévia Pública. Para localizar sua versão da CLI do Databricks, execute databricks -v.

O grupo de comandos configure na CLI do Databricks permite autenticar a CLI do Databricks com o Azure Databricks usando tokens de acesso pessoal do Azure Databricks ou tokens do Microsoft Entra ID (antigo Azure Active Directory).

Observação

Como melhor prática de segurança, ao autenticar com ferramentas, sistemas, scripts e aplicativos automatizados, o Databricks recomenda que você use tokens de acesso pertencentes às entidades de serviço e não aos usuários do workspace. Para criar tokens para entidades de serviço, consulte Gerenciar tokens para uma entidade de serviço.

Observe que este artigo abrange apenas o token de acesso pessoal do Azure Databricks e a autenticação de token do Microsoft Entra ID (anteriormente Azure Active Directory) para permitir a chamada de comandos no nível do espaço de trabalho. Para ver mais opções de configuração de autenticação, confira Autenticação da CLI do Databricks.

Importante

Antes de você executar esse comando, certifique-se de configurar a CLI do Databricks.

Você executa comandos configure anexando-os a databricks configure. Para exibir a ajuda para o comando configure, execute databricks configure -h.

Criar um perfil de configuração

Um perfil de configuração é uma coleção de configurações que contém informações de autenticação, como uma URL do workspace do Azure Databricks e um valor de token de acesso. Um perfil de configuração tem um nome programático, como DEFAULT, DEV ou PROD.

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

databricks configure --host <workspace-url>

Para <workspace-url>, insira sua URL por workspace, com o formato https://adb-<workspace-id>.<random-number>.azuredatabricks.net. Para obter a URL por workspace, confira URL por workspace.

O comando solicita que você insira o token de acesso pessoal do Azure Databricks ou o token do Microsoft Entra ID (antigo Azure Active Directory) que é mapeado para o <workspace-url> especificado:

✔ Databricks Token:

Depois de inserir o token de acesso, o token de acesso é 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 opção --profile ao comando configure, por exemplo:

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

Dica

Pressione Tab depois de --profile ou -p para visualizar uma lista de perfis de configuração disponíveis existentes para sua escolha, em vez de inserir o nome do perfil de configuração manualmente.

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

Adicionar vários perfis de conexão ao arquivo .databrickscfg permite que você execute comandos rapidamente em vários workspaces especificando o nome do perfil de conexão de destino na opção do comando --profile. Se você não especificar a opção --profile em um comando que dá suporte a essa opção, o comando usará o perfil de conexão DEFAULT por padrão.

Por exemplo, você pode ter um perfil de conexão chamado DEV que faz referência a um workspace 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 faz referência a um workspace do Azure Databricks diferente que você usa para cargas de trabalho de produção.

Você pode alterar o caminho padrão desse arquivo .databrickscfg definindo a variável de ambiente DATABRICKS_CONFIG_FILE. Para saber como definir variáveis de ambiente, confira a documentação do sistema operacional.

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