Perfis de configuração para a CLI do Databricks

Observação

Esta informação se aplica às versões 0.205 e acima do Databricks CLI, que estão em Public Preview. Para encontrar sua versão da CLI do Databricks, execute databricks -v.

Este artigo descreve como configurar a autenticação entre a CLI do Databricks e sua account e workspace do Databricks. Consulte O que é a CLI do Databricks?.

Este artigo pressupõe que você já instalou a CLI do Databricks e configurou a CLI para autenticação. Ver:

• Instalar ou atualizar a CLI do Databricks

• Autenticação para a CLI do Databricks

Obtenha informações sobre perfis de configuração

A adição de vários perfis de configuração ao arquivo .databrickscfg permite executar comandos rapidamente em vários workspace , especificando o nome do perfil de configuração de destino na opção --profile ou -p do comando, para os comandos que suportam essa opção. Se você não especificar a opção --profile ou -p em um comando que suporte essa opção, o comando usará o perfil de configuração DEFAULT por default.

Dica

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

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

Por default, a CLI do Databricks procura o arquivo .databrickscfg em seu ~ (seu usuário pasta home no Unix, Linux ou macOS, ou em seu %USERPROFILE% (seu usuário pasta home no Windows. Você pode alterar o caminho default do arquivo .databrickscfg definindo a variável de ambiente DATABRICKS_CONFIG_FILE. Para saber como definir variável de ambiente, consulte a documentação do seu sistema operacional.

Para obter informações sobre um perfil de configuração existente, execute o comando auth env :

databricks auth env --profile <configuration-profile-name>

# Or:
databricks auth env --host <account-console-url>

# Or:
databricks auth env --host <workspace-url>

Por exemplo, aqui está a saída para um perfil configurado com autenticação access token pessoal do Databricks:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<configuration-profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Para obter informações sobre todos os perfis disponíveis, execute o comando auth profiles :

databricks auth profiles

Saída (as reticências representam conteúdo omitido, por questões de brevidade):

{
  "profiles": [
    {
      "name": "<configuration-profile-name>",
      "host": "<workspace-url>",
      "cloud": "<cloud-id>",
      "auth_type": "<auth-type>",
      "valid": true
    },
    {
      "...": "..."
    }
  ]
}

A saída do comando auth profiles não exibe nenhum access token. Para exibir um access token, execute o comando auth env anterior.

Importante

A CLI do Databricks não funciona com um arquivo .netrc. Você pode ter um arquivo .netrc em seu ambiente para outras finalidades, mas a CLI do Databricks não usará esse arquivo .netrc .

Teste a configuração do seu perfil de configuração DEFAULT

Para verificar se você configurou a autenticação corretamente, você pode executar um comando como o seguinte, que lista as versões disponíveis do Databricks Runtime para o workspace do Databricks associado ao seu perfil DEFAULT.

A chamada a seguir pressupõe que você não tenha nenhuma variável de ambiente especial definida, que tenha precedência sobre as configurações do seu perfil DEFAULT . Para mais informações, consulte Ordem de avaliação de autenticação.

databricks clusters spark-versions

Teste seus perfis de configuração

Para verificar se você configurou algum perfil de configuração corretamente, você pode executar um comando como o seguinte com um dos nomes de perfil de configuração no nível workspace . Este comando lista as versões do Databricks Runtime disponíveis para o workspace do Databricks associado ao perfil de configuração especificado, representado aqui pelo espaço reservado <configuration-profile-name>:

databricks clusters spark-versions -p <configuration-profile-name>

Dica

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

Para listar detalhes de um perfil específico, execute o seguinte comando:

databricks auth env --profile <configuration-profile-name>

Para listar detalhes de todos os seus perfis disponíveis, execute o seguinte comando:

databricks auth profiles