configure
comando
Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.
Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.
O comando ` configure
` na CLI do Databricks permite autenticar a CLI do Databricks com o Databricks usando tokens de acesso pessoal do Databricks.
Como prática recomendada de segurança ao autenticar-se com ferramentas, sistemas, scripts e aplicativos automatizados, a Databricks recomenda o uso de tokens OAuth.
Se utilizar autenticação por tokens de acesso pessoal, Databricks recomenda utilizar tokens de acesso pessoal pertencentes a entidade de serviço em vez de utilizadores workspace. tokens Para criar uma entidade de serviço, consulte gerenciar tokens para uma entidade de serviço.
Este artigo aborda apenas a autenticação de tokens de um Databricks, para permitir a chamada de um comando no nível de umworkspace. Para opções adicionais de configuração de autenticação, consulte Autenticação para a CLI do Databricks.
configuração de databricks
Configure um perfil em seu arquivo ~/.databrickscfg
. Um perfil de configuração é um conjunto de definições que contém informações de autenticação, como um URL Databricks workspace 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 arquivo “ .databrickscfg
” permite que você execute rapidamente o comando em várias áreas de trabalho, especificando o nome do perfil de conexão de destino na opção “ --profile
” do comando. Se não especificar a opção “ --profile
” em um comando que suporte essa opção, o comando utilizará o perfil de conexão “ DEFAULT
” por “ default”.
Por exemplo, você pode ter um perfil de conexão chamado DEV
que faz referência a um Databricks workspace que você usa para cargas de trabalho de desenvolvimento e um perfil de conexão separado chamado PROD
que faz referência a um Databricks workspace diferente que você usa para cargas de trabalho de produção.
Para obter informações sobre os perfis de configuração existentes, utilize o grupo de comandosauth
.
É possível alterar o caminho default do arquivo .databrickscfg
definindo a variável de ambiente DATABRICKS_CONFIG_FILE
.
Se este comando for invocado no modo não interativo, ele lerá os tokens 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 agrupamento
--host string
Databricks workspace URL do host
A URL do host do workspace é https://
seguida do nome da sua instância, por exemplo, https://<prefix>.cloud.databricks.com
. Para obter o nome da sua instância, consulte nomes, URLs e IDs de instâncias do espaço de trabalho.
--profile string
Nome do perfil de conexão a ser configurado. (default " padrão")
Exemplos
O exemplo a seguir configura a autenticação para o perfil default:
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 de clustering:
databricks configure --configure-cluster
Bandeiras globais
--debug
Se deve habilitar o registro de depuração.
-h
ou --help
Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file
string
Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
--log-format
Formato
O tipo de formato do log, text
ou json
. O valor de default é text
.
--log-level
string
Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.
-o, --output
Tipo
O tipo de saída do comando, text
ou json
. O valor de default é text
.
-p, --profile
string
O nome do perfil no arquivo ~/.databrickscfg
a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT
será usado.
--progress-format
Formato
O formato para exibir o progresso logs: 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 comando configure
:
databricks configure --host <workspace-url>
O comando solicita que você insira seus tokens de acesso pessoal Databricks que correspondem ao <workspace-url>
especificado:
✔ Databricks Token:
Após inserir seus tokens de acesso, eles serão armazenados no arquivo “ ~/.databrickscfg
” no Linux ou macOS, ou “ %USERPROFILE%\.databrickscfg
” no Windows por default. O arquivo contém uma entrada de perfil de conexão default chamada DEFAULT
:
[DEFAULT]
host = <workspace-url>
token = <access-token>
Para utilizar um nome diferente para o 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>
Você pode pressionar Tab
após --profile
ou -p
para exibir a lista de perfis de configuração disponíveis existentes para escolher, em vez de inserir o nome do perfil de configuração manualmente.
Qualquer informação existente sobre host e tokens dentro do perfil de conexão especificado será substituída pela nova informação sobre host e tokens.