auth grupo de 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 grupo de comandos auth dentro do Databricks CLI contém comandos relacionados à autenticação, incluindo os seguintes:
- 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.
- Utilize a autenticação de usuário para máquina (U2M) OAuth para autenticar o Databricks CLI com sua conta Databricks e sua área de trabalho.
- Para sair de um perfil, limpe tokens OAuth armazenados em cache e, opcionalmente, remova a entrada do perfil.
- Obtenha informações sobre qualquer acesso a OAuth em tokens que o Databricks CLI possa ter armazenado em cache.
- Obtenha detalhes sobre a configuração que a CLI do Databricks está utilizando para autenticação.
Para obter informações sobre o usuário atual do Databricks CLI , execute databricks current-user me.
descrição da autenticação do databricks
Descreve a configuração que a CLI do Databricks está usando para autenticar, incluindo as credenciais e a origem dessas credenciais. Se nenhuma opção for especificada, o comando auth describe seguirá a prioridade do método de autenticação.
databricks auth describe [flags]
Opções
--sensitive
Inclua campos confidenciais, como senhas e tokens, na saída.
Exemplos
O exemplo a seguir descreve a configuração de autenticação atual:
databricks auth describe
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 específico workspace são utilizadas, especifique a opção --host juntamente com o URL do workspace.
databricks auth describe --host https://<workspace-instance-name>
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 específico account são utilizadas, especifique a opção --host juntamente com o URL da console Databricks account , https://accounts.cloud.databricks.com.
databricks auth describe --host <account-console-url>
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 são utilizadas, especifique a opção -p ou --profile juntamente com o nome do perfil:
databricks auth describe -p TEST
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: TEST (from --profile flag)
✓ auth_type: <authentication-type>
Para incluir informações confidenciais na saída (como Databricks personal access tokens e client secrets), especifique a opção --sensitive:
databricks auth describe --sensitive
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
ambiente de autenticação do databricks
Este comando está obsoleto.
Obtenha informações sobre um perfil de configuração existente utilizando o nome do perfil ou o URL do console Databricks account ou o URL Databricks workspace .
databricks auth env [flags]
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.
Para criar um perfil de configuração, consulte o comandoconfigure.
Opções
--host string
Nome do host para o qual obter o ambiente de autenticação
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, você pode ter um perfil que possui apenas um valor de host e outro perfil que possui o mesmo valor de host, mas também um valor de tokens. Nesse caso, a CLI do Databricks não seleciona um perfil e é interrompida. Para auxiliar a CLI do Databricks a selecionar o perfil desejado, tente especificar um valor diferente para --host. Para valores de --host que são URLs de console account, tente especificar um valor --account-id em vez de um valor --host.
--profile string
Perfil para o qual obter o ambiente de autenticação
Exemplos
O exemplo a seguir obtém o ambiente de autenticação default:
databricks auth env
O exemplo a seguir mostra o ambiente de autenticação de um host específico:
databricks auth env --host https://my-workspace.cloud.databricks.com
A saída para um perfil configurado com autenticação por tokens de acesso " Databricks " pode ser:
{
"env": {
"DATABRICKS_AUTH_TYPE": "pat",
"DATABRICKS_CONFIG_PROFILE": "TEST",
"DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
"DATABRICKS_TOKEN": "<token-value>"
}
}
O exemplo a seguir mostra o ambiente de autenticação para um perfil específico:
databricks auth env --profile my-test-environment
login de autenticação do databricks
Faça login em um workspace ou account Databricks e salve a configuração de autenticação em um perfil (em ~/.databrickscfg por default). O perfil pode então ser usado para autenticar outros comandos CLI Databricks usando a flag --profile . O perfil também pode ser usado para autenticar outras ferramentas do Databricks que suportam a autenticação unificada do Databricks, incluindo os SDKs do Databricks para Python, Java e Go.
databricks auth login HOST [flags]
Este comando requer que sejam especificados um URL do host Databricks (utilizando --host ou como um argumento posicional ou inferido implicitamente a partir do nome do perfil especificado) e um nome de perfil (utilizando --profile). Se você não especificar esses valores, você será solicitado a fornecer valores em tempo de execução.
Embora este comando sempre o conecte como logs ao host especificado, o comportamento depende dos perfis existentes que você definiu no seu arquivo de configuração (em ~/.databrickscfg por default):
- Se um perfil com o nome especificado existir e indicar um host, o usuário será conectado ao host especificado pelo perfil. O perfil será atualizado para utilizar "databricks-CLI" como tipo de autenticação, caso não fosse esse o caso anteriormente.
- Se existir um perfil com o nome especificado, mas não especificar um host, você será solicitado a especificar um host. O perfil será atualizado para usar o host especificado. O tipo de autenticação será atualizado para "databricks-CLI" , caso não fosse esse o caso anteriormente.
- Se existir um perfil com o nome especificado e especificar um host, mas você especificar um host usando
--host(ou como argumento posicionalHOST), o perfil será atualizado para usar o host recém-especificado. O tipo de autenticação será atualizado para "databricks-CLI" , caso não fosse esse o caso anteriormente. - Se um perfil com o nome especificado não existir, um novo perfil será criado com o host especificado. O tipo de autenticação será definido como "databricks-CLI" .
Argumentos
HOST
URL do host do Databricks (opcional)
Opções
--configure-cluster
Solicitações para configurar cluster ( compute clássica)
--configure-serverless
Solicitações para configurar compute serverless
--timeout duration
Tempo limite para concluir o desafio de login no navegador (default 1h0m0s)
Exemplos
O exemplo a seguir logs em Databricks workspace:
databricks auth login
O exemplo a seguir logs em um Databricks específico workspace:
databricks auth login https://my-workspace.cloud.databricks.com
O exemplo a seguir faz login com um perfil específico e configura as definições de clustering:
databricks auth login --profile my-profile --configure-cluster
O exemplo a seguir define um tempo limite personalizado para o processo de login:
databricks auth login --timeout 30m
autenticação databricks logout
Para sair de um perfil Databricks , limpe os tokens OAuth armazenados em cache. Você precisará executar databricks auth login para se autenticar novamente. O perfil permanece no arquivo de configuração (~/.databrickscfg por default) a menos que você também especifique --delete.
databricks auth logout [PROFILE] [flags]
Este comportamento aplica-se apenas a perfis criados com databricks auth login (auth_type definido como databricks-cli). Perfis que utilizam outros métodos de autenticação, como access tokens pessoal ou credenciais de máquina para máquina, não armazenam tokens OAuth em cache, portanto não há nada a ser limpo. Se vários perfis compartilharem os mesmos tokens em cache, sair de um deles não afetará os outros.
Comportamento do comando:
- Se você especificar um perfil (como o argumento
PROFILEou com--profile), o comando logs logout desse perfil. Você também pode fornecer um URL de host, que o comando resolve para o perfil correspondente. Em um terminal interativo, ele pede confirmação a menos que você também especifique--auto-approve. - Se você omitir o perfil em um terminal interativo, o comando exibirá um seletor de perfil pesquisável. Você pode pesquisar por nome de perfil, anfitrião ou ID account . Depois de selecionar um perfil, o comando pede confirmação, a menos que você também especifique
--auto-approve. - Se você omitir o perfil em um ambiente não interativo, o comando falhará e solicitará que você especifique um perfil.
- Em um ambiente não interativo, especifique um perfil junto com
--auto-approvepara ignorar a confirmação.
Argumentos
PROFILE
Nome do perfil ou URL do host para log (opcional). O argumento é primeiramente comparado com os nomes de perfil existentes. Se nenhum perfil corresponder e o argumento parecer um URL de host, o comando o resolverá para o(s) perfil(is) configurado(s) para esse host. Se vários perfis corresponderem a um host, o comando solicitará que você selecione um (ou exibirá erros no modo não interativo).
Opções
--delete
Remova também o perfil do arquivo de configuração (~/.databrickscfg por default)
--auto-approve
Ignore a mensagem de confirmação
Exemplos
O exemplo a seguir logs de um perfil específico:
databricks auth logout my-profile
O exemplo a seguir logs do perfil associado a um URL de host:
databricks auth logout https://my-workspace.cloud.databricks.com
O exemplo a seguir logs e remove o perfil do arquivo de configuração:
databricks auth logout --profile my-profile --delete
O exemplo a seguir logs sem solicitar confirmação, sendo adequado para CI/CD:
databricks auth logout my-profile --auto-approve
perfis de autenticação do databricks
Liste todos os perfis de configuração disponíveis (em ~/.databrickscfg por default) e verifique se são perfis válidos.
databricks auth profiles [flags]
Este comando exibe perfis no seguinte formato:
Name Host Valid
DEFAULT https://<host-url> YES
<profile-name> https://<host-url> NO
Para determinar se cada perfil é válido, o Databricks CLI lista o espaço de trabalho 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á exibida uma mensagem de sucesso ( YES ); caso contrário, será exibida uma mensagem de erro ( NO ).
A saída do comando " auth profiles " não exibe nenhum acesso tokens. Para exibir tokens de acesso, consulte o ambiente de autenticação do Databricks.
Por default, os perfis de configuração são armazenados no arquivo ~/.databrickscfg no Linux ou macOS, ou %USERPROFILE%\.databrickscfg em Windows. É possível alterar o caminho default deste arquivo definindo a variável de ambiente DATABRICKS_CONFIG_FILE.
Para criar perfis de configuração, consulte o comandoconfigure.
Opções
--skip-validate
Se deve pular a validação dos perfis
Exemplos
O exemplo a seguir lista todos os perfis de autenticação:
databricks auth profiles
O exemplo a seguir lista perfis sem validá-los:
databricks auth profiles --skip-validate
chave de autenticação do Databricks
Defina um perfil nomeado como default em ~/.databrickscfg. O nome do perfil selecionado é armazenado em uma seção [__settings__] no arquivo de configuração sob a key default_profile . Use databricks auth profiles para ver qual perfil é atualmente o default.
databricks auth switch [flags]
Opções
Exemplos
O exemplo a seguir seleciona interativamente um perfil para definir como default:
databricks auth switch
O exemplo a seguir define um perfil específico como default:
databricks auth switch --profile my-profile
tokens de autenticação do Databricks
Obtenha os tokens de autenticação do cache local em ~/.databricks/token-cache.json. Atualize o access token se ele estiver expirado ou perto de expirar. Este comando só funciona com autenticação U2M (usando o comando databricks auth login ). A autenticação M2M usando um ID de cliente e uma chave secreta não é suportada.
databricks auth token [HOST_OR_PROFILE] [flags]
Para configurar e definir a autenticação OAuth U2M, consulte Autenticação OAuth usuário para máquina (U2M).
Argumentos
HOST_OR_PROFILE
URL do host do Databricks ou nome do perfil (opcional)
Opções
--account-id string
Databricks ID da conta
--force-refresh
Forçar uma refresh dos tokens mesmo que os tokens em cache ainda sejam válidos.
--timeout duration
Tempo limite para aquisição de tokens. (default 1h0m0s)
Exemplos
O exemplo a seguir obtém os tokens de autenticação:
databricks auth token
O exemplo a seguir obtém os tokens de autenticação para um host específico:
databricks auth token https://my-workspace.cloud.databricks.com
A saída pode ser:
{
"access_token": "<token-value>",
"token_type": "Bearer",
"expiry": "<token-expiration-date-time>"
}
O exemplo a seguir define um tempo limite personalizado para a aquisição de tokens:
databricks auth token --timeout 30m
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