Perfis de configuração da CLI do Databricks

Observação

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 disposições de Dados de Uso.

Este ar descreve como configurar a autenticação entre a CLI do Databricks e suas contas e workspaces do Azure Databricks. Confira 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. Consulte:

• Instalar ou atualizar a CLI do Databricks
• Autenticação da CLI do Databricks

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

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

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.

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

Por padrão, a CLI do Databricks procura esse arquivo .databrickscfg na pasta ~ (sua página inicial do usuário) no Unix, Linux ou macOS ou sua pasta %USERPROFILE% (sua página inicial do usuário) no Windows. Você pode alterar o caminho do 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 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 a autenticação de token de acesso pessoal do Azure 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, para fins 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 token de acesso. Para exibir um token de acesso, execute o comando anterior auth env.

Importante

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

Testar a configuração do perfil de configuração PADRÃO

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 Azure 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 em seu perfil DEFAULT. Para obter mais informações, consulte Ordem de avaliação de autenticação.

databricks clusters spark-versions

Testar seus perfis de configuração

Para verificar se você configurou os perfis de configuração corretamente, você pode executar um comando como o seguinte com um dos nomes de perfil de configuração no nível do workspace. Este comando lista as versões disponíveis do Databricks Runtime para o workspace do Azure 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

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.

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