Compartilhar via


configure comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

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

Note

Como prática recomendada de segurança, quando você se autentica com ferramentas automatizadas, sistemas, scripts e aplicativos, o Databricks recomenda que você use tokens de acesso pessoal pertencentes a entidades de serviço em vez de 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 cobre apenas o uso de token de acesso pessoal do Azure Databricks e autenticação de token do Microsoft Entra ID para habilitar a execução de comandos em nível de espaço de trabalho. Para ver mais opções de configuração de autenticação, confira Autenticação da CLI do Databricks.

configuração do databricks

Configure um perfil no seu arquivo ~/.databrickscfg. 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. Adicionar vários perfis ao .databrickscfg arquivo permite que você execute comandos rapidamente em vários workspaces especificando o nome do perfil de conexão de destino na opção do --profile comando. 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.

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

Você pode alterar o caminho padrão do .databrickscfg arquivo definindo a variável DATABRICKS_CONFIG_FILEde 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 variável de ambiente DATABRICKS_HOST.

databricks configure [flags]

Opções

--configure-cluster

    Solicitações para configurar o cluster

--host string

    URL do host do espaço de trabalho do Databricks

O URL do host do workspace é o URL específico para cada workspace, com o formato https://adb-<workspace-id>.<random-number>.azuredatabricks.net. Para obter a URL por workspace, confira URL por workspace.

--profile string

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

Sinalizadores globais

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 a configuração do cluster:

databricks configure --configure-cluster

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

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

--log-file corda

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

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

    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 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>

Tip

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.