Autenticação para a CLI da Databricks

nota

Essas informações se aplicam ao site Databricks CLI versões 0.205 e superiores. A CLI da Databricks está em visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks, incluindo qualquer provisionamento de Dados de Uso.

Este artigo explica como configurar a autenticação entre o Databricks CLI e sua conta e espaço de trabalho Databricks. Ele pressupõe que o senhor já tenha instalado a CLI da Databricks. Consulte Instalar ou atualizar a CLI da Databricks.

Antes de executar o comando Databricks CLI , é necessário configurar a autenticação para a conta ou o espaço de trabalho que o senhor planeja usar. A configuração necessária depende de se o senhor deseja executar workspace-level comando, account-level comando ou ambos.

Para view grupos de comando CLI disponíveis, execute databricks -h. Para obter a lista de operações correspondentes da API REST, consulte API REST da Databricks.

Autenticação OAuth máquina a máquina (M2M)

A autenticação máquina a máquina (M2M) com OAuth permite que serviços, scripts ou aplicativos acessem Databricks recurso sem o login interativo do usuário. Em vez de depender de tokens de acesso pessoal (PATs) ou credenciais de usuário, a autenticação M2M usa uma entidade de serviço e um fluxo de credenciais de cliente OAuth para solicitar e gerenciar tokens.

Para configurar e usar a autenticação OAuth M2M:

Conclua as etapas de configuração da autenticação OAuth M2M. Consulte Autorizar o acesso da entidade de serviço ao Databricks com o OAuth.

Crie um perfil de configuração do Databricks com os seguintes campos em seu arquivo .databrickscfg.

Para account-level comando

[<some-unique-configuration-profile-name>]
host          = <account-console-url>
account_id    = <account-id>
client_id     = <service-principal-client-id>
client_secret = <service-principal-oauth-secret>

Para workspace-level comando

[<some-unique-configuration-profile-name>]
host          = <workspace-url>
client_id     = <service-principal-client-id>
client_secret = <service-principal-oauth-secret>

Para usar o perfil, passe-o com o sinalizador --profile ou -p em CLI comando. Por exemplo:

Bash
databricks account groups list -p <profile-name>

Pressione tab após --profile ou -p para exibir uma lista de perfis disponíveis.

Autenticação OAuth de usuário para máquina (U2M)

Com a autenticação OAuth user-to-machine (U2M), o senhor log in interativamente e o CLI gerencia o tokens de curta duração em seu nome. OAuth tokens expiram em menos de uma hora, o que reduz o risco se um token for acidentalmente exposto. Consulte Autorizar o acesso do usuário ao Databricks com o OAuth.

Para log in:

Para account-level comando

Bash
databricks auth login --host <account-console-url> --account-id <account-id>

Para workspace-level comando

Bash
databricks auth login --host <workspace-url>

O site CLI guia o senhor por um fluxo de login baseado em navegador. Quando o senhor terminar, a CLI salvará as credenciais como um perfil de configuração. Você pode aceitar o nome de perfil sugerido ou inserir o seu próprio.

Para usar o perfil, passe-o com o sinalizador --profile ou -p em CLI comando. Por exemplo:

Bash
databricks clusters list -p <profile-name>

Pressione tab após --profile ou -p para exibir uma lista de perfis disponíveis.

Autenticação de credenciais do Google Cloud

A autenticação de credenciais do Google Cloud usa credenciais account do Google Cloud Service para autenticar a account do Google Cloud Service de destino. Veja também Autenticar com credenciais do Google Cloud.

Para configurar a autenticação de credenciais do Google Cloud, você precisa ter a autenticação do Google Cloud ID instalada localmente. Você também deve fazer o seguinte:

Crie ou identifique um perfil de configuração do Databricks com os seguintes campos em seu arquivo .databrickscfg. Se você criar o perfil, substitua os espaços reservados pelos valores apropriados.

Para account-level comando, defina os seguintes valores em seu arquivo .databrickscfg:
```
[<some-unique-configuration-profile-name>]
host               = <account-console-url>
account_id         = <account-id>
google_credentials = <path-to-google-service-account-credentials-file>
```
Para workspace-level comando, defina os seguintes valores em seu arquivo .databrickscfg:
```
[<some-unique-configuration-profile-name>]
host               = <workspace-url>
google_credentials = <path-to-google-service-account-credentials-file>
```
Use a opção --profile ou -p da CLI da Databricks seguida pelo nome do perfil de configuração, como parte da chamada de comando da CLI da Databricks, por exemplo, databricks account groups list -p <configuration-profile-name> ou databricks clusters list -p <configuration-profile-name>.

dica

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.

Autenticação do Google Cloud ID

A autenticação do Google Cloud ID autentica o serviço de destino do Google Cloud account. Consulte Autenticação do Google Cloud ID.

Para configurar a autenticação do Google Cloud ID, você precisa ter a autenticação do Google Cloud ID instalada localmente. Você também deve fazer o seguinte:

Crie ou identifique um perfil de configuração do Databricks com os seguintes campos em seu arquivo .databrickscfg. Se você criar o perfil, substitua os espaços reservados pelos valores apropriados.

Para account-level comando, defina os seguintes valores em seu arquivo .databrickscfg:
```
[<some-unique-configuration-profile-name>]
host                   = <account-console-url>
account_id             = <account-id>
google_service_account = <google-cloud-service-account-email-address>
```
Para workspace-level comando, defina os seguintes valores em seu arquivo .databrickscfg:
```
[<some-unique-configuration-profile-name>]
host                   = <workspace-url>
google_service_account = <google-cloud-service-account-email-address>
```
Use a opção --profile ou -p da CLI da Databricks, seguida do nome do perfil de configuração, como parte da chamada de comando da CLI da Databricks, por exemplo, databricks clusters list -p <configuration-profile-name>.

dica

Ordem de avaliação de autenticação

Sempre que o Databricks CLI se autentica em um Databricks workspace ou account, ele procura as configurações necessárias na seguinte ordem:

Arquivos de configuração do pacote , para execução do comando a partir de um diretório de trabalho do pacote. Os arquivos de configurações do pacote não podem conter valores de credenciais diretamente.
O senhor pode usar os campos para autenticação unificada, conforme listado neste artigo e em variável de ambiente e campos para autenticação unificada.
Perfis de configuração no arquivo .databrickscfg.

Assim que a CLI encontra a configuração necessária, ela para de procurar em outros locais.

Exemplos:

Se uma variável de ambiente DATABRICKS_TOKEN for definida, a CLI a usará, mesmo que existam vários tokens em .databrickscfg.
Se nenhum DATABRICKS_TOKEN for definido e um ambiente de pacote fizer referência a um nome de perfil, como dev → perfil DEV, a CLI usará as credenciais desse perfil em .databrickscfg.
Se nenhum DATABRICKS_TOKEN for definido e um ambiente de pacote especificar um valor host, a CLI procurará um perfil em .databrickscfg com um host correspondente e usará seu token.

Autenticação de tokens de acesso pessoal (obsoleta)

important

A autenticação básica usando um nome de usuário e senha da Databricks chegou ao fim da vida útil em 10 de julho de 2024. Para se autenticar com Databricks account, use um dos seguintes métodos de autenticação:

Autenticação OAuth machine-to-machine (M2M)
Autenticação OAuth user-to-machine (U2M)
Autenticação de credenciais do Google Cloud
Autenticação de ID do Google Cloud

A autenticação access token pessoal Databricks usa um access token pessoal Databricks para autenticar a entidade de destino Databricks , como uma account de usuário Databricks ou uma entidade de serviço Databricks . Consulte Autenticar com access tokens pessoal Databricks (legado).

Para criar um access token pessoal, siga os passos em Criar access tokens pessoais para usuários workspace.

Autenticação OAuth máquina a máquina (M2M)​

Autenticação OAuth de usuário para máquina (U2M)​

Autenticação de credenciais do Google Cloud​

Autenticação do Google Cloud ID​

Ordem de avaliação de autenticação​

Autenticação de tokens de acesso pessoal (obsoleta)​