auth grupo de comando
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.
O grupo de comando auth dentro do Databricks CLI permite ao senhor:
- Liste todos os perfis de configuração de autenticação disponíveis.
- Obter informações sobre um perfil de configuração de autenticação individual.
- Use a autenticação OAuth user-to-machine (U2M) para autenticar o Databricks CLI com sua conta e espaço de trabalho Databricks.
- Obtenha informações sobre qualquer acesso OAuth tokens que o Databricks CLI possa ter armazenado em cache.
- Obtenha detalhes sobre a configuração que a CLI da Databricks está usando para autenticar.
O senhor executa auth comando anexando-os a databricks auth. Para exibir a ajuda do comando auth, execute databricks auth -h.
Listar perfis de configuração
Para obter uma lista de todos os perfis de configuração disponíveis e verificar se eles são válidos, execute o comando auth profiles, como segue:
databricks auth profiles
Saída (as elipses representam conteúdo omitido, para resumir):
Name Host Valid
DEFAULT https://<host-url> YES
<profile-name> https://<host-url> NO
Para determinar se cada perfil é válido, o Databricks CLI executa um comando list workspace para cada perfil de nível accounte executa um comando get current user para cada perfil de nível workspace. Se o comando for bem-sucedido, será exibido YES; caso contrário, será exibido NO.
A saída do comando auth profiles não exibe nenhum acesso tokens. Para exibir os tokens de acesso, consulte Obter informações sobre um perfil de configuração.
Os perfis de configuração são armazenados no arquivo ~/.databrickscfg no Linux ou macOS, ou %USERPROFILE%\.databrickscfg em Windows por default. O senhor pode alterar o caminho default desse arquivo definindo a variável de ambiente DATABRICKS_CONFIG_FILE. Para saber como definir a variável de ambiente, consulte a documentação do seu sistema operacional.
Para criar perfis de configuração, consulte o grupo de comandoconfigure.
Obter informações sobre um perfil de configuração
Para obter informações sobre um perfil de configuração existente, execute o comando auth env, em que <profile-name> representa o nome do perfil e <account-or-workspace-url> representa o URL do console Databricks account ou o URL Databricks workspace , como segue:
databricks auth env --profile <profile-name>
# Or:
databricks auth env --host <account-or-workspace-url>
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.
Por exemplo, aqui está o resultado de um perfil configurado com a autenticação de tokens de acesso Databricks:
{
"env": {
"DATABRICKS_AUTH_TYPE": "pat",
"DATABRICKS_CONFIG_PROFILE": "<profile-name>",
"DATABRICKS_HOST": "<workspace-url>",
"DATABRICKS_TOKEN": "<token-value>"
}
}
Se mais de um perfil corresponder ao valor --host, um erro será exibido, informando que ele não consegue encontrar um único perfil correspondente. Por exemplo, o senhor pode ter um perfil que tenha apenas um valor de host e outro perfil que tenha o mesmo valor de host, mas também um valor de tokens. Nesse caso, a CLI do Databricks não escolhe um perfil e para. Para ajudar a CLI do Databricks a escolher o perfil desejado, tente especificar um valor diferente em --host. Para valores --host que são URLs do console account, tente especificar um valor --account-id em vez de um valor --host.
Para criar um perfil de configuração, consulte o grupo de comandoconfigure.
Autenticar com o OAuth
Em vez de autenticar com a Databricks usando tokens de acesso e perfis de configuração, o senhor pode usar a autenticação OAuth de usuário para máquina (U2M). O OAuth fornece tokens com tempos de expiração mais rápidos do que os tokens de acesso pessoal do Databricks e oferece melhor invalidação e escopo de sessão no lado do servidor. Como os tokens de acesso OAuth expiram em menos de uma hora, isso reduz o risco associado à verificação acidental de tokens no controle de origem. Consulte Autorizar o acesso interativo a Databricks recurso com um usuário account usando OAuth.
Para configurar e definir a autenticação OAuth U2M, consulte Autenticação OAuth de usuário para máquina (U2M).
Obter detalhes dos tokens de acesso OAuth
Se você quiser ver informações sobre os access tokens OAuth em cache que a CLI do Databricks gerou anteriormente para um workspace do Databricks, execute o comando auth token, em que <workspace-url> representa a URL do workspace do Databricks, da seguinte maneira:
databricks auth token <workspace-url>
Saída:
{
"access_token": "<token-value>",
"token_type": "Bearer",
"expiry": "<token-expiration-date-time>"
}
Obtenha detalhes de autenticação
Para obter detalhes sobre a configuração que o Databricks CLI está usando para autenticar, execute o comando auth describe.
Se nenhuma opção for especificada, o comando auth describe seguirá os métodos padrão para autenticação unificada do cliente.
databricks auth describe
Saída:
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
✓ profile: default
✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)
Para especificar que as informações sobre um Databricks workspace específico sejam usadas, especifique a opção --host junto com o URL do workspace.
databricks auth describe --host https://<workspace-instance-name>
Saída:
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
✓ host: https://<workspace-instance-name> (from --host flag)
✓ profile: default
✓ auth_type: <authentication-type>
Para especificar que as informações sobre um Databricks account específico sejam usadas, especifique a opção --host junto com o URL do console Databricks account , https://accounts.cloud.databricks.com.
databricks auth describe --host <account-console-url>
Saída:
Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
✓ host: <account-console-url> (from --host flag)
✓ account_id: <account-id>
✓ profile: default
✓ auth_type: <authentication-type>
Para especificar que as informações sobre um perfil de configuração específico do Databricks sejam usadas, especifique a opção -p ou --profile junto com o nome do perfil.
databricks auth describe -p <profile-name>
Saída:
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
✓ token: ******** (from <path>/<to>/.databrickscfg config file)
✓ profile: <profile-name> (from --profile flag)
✓ auth_type: <authentication-type>
Para incluir informações confidenciais na saída (como o acesso pessoal Databricks tokens e segredos do cliente), especifique a opção --sensitive.
databricks auth describe --sensitive
Saída:
Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
✓ profile: <profile-name>
✓ auth_type: pat