`auth` grupo de comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-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.

O auth grupo de comandos dentro da CLI do Databricks contém comandos relacionados à autenticação, incluindo o seguinte:

Liste todos os perfis de configuração de autenticação disponíveis.
Obtenha informações sobre um perfil de configuração de autenticação individual.
Use a autenticação de usuário para máquina (U2M) OAuth para autenticar a CLI do Databricks com suas contas e espaços de trabalho do Azure Databricks.
Obtenha informações sobre quaisquer tokens de acesso OAuth que a CLI do Databricks possa ter armazenado em cache.
Obtenha detalhes sobre a configuração que a CLI do Databricks está usando para autenticar.

Tip

Para obter informações sobre o usuário atual da CLI do Databricks, execute databricks current-user me.

databricks auth descrever

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 seguirá auth describe 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

Bandeiras globais

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 espaço de trabalho específico do Azure Databricks são usadas, especifique a --host opção junto com a URL do espaço de trabalho.

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 uma conta específica do Azure Databricks são usadas, especifique a --host opção junto com a URL do console da conta do Azure Databricks, https://accounts.azuredatabricks.net.

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 Azure Databricks sejam usadas, especifique a -p opção ou --profile junto 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 tokens de acesso pessoal e segredos de cliente do Azure Databricks), especifique a --sensitive opção:

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

databricks auth env |

Obtenha informações sobre um perfil de configuração existente usando o nome do perfil ou a URL do console da conta do Azure Databricks ou a URL do espaço de trabalho do Azure Databricks.

databricks auth env [flags]

Tip

Você pode pressionar Tab após --profile ou -p para exibir uma 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 configure comando.

Opções

--host string

Nome do host para obter auth env para

Note

Se mais de um perfil corresponder ao --host valor, será exibido um erro, informando que não é possível encontrar um único perfil correspondente. Por exemplo, você 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 token. 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 --host . Para --host valores que são URLs de console de conta, tente especificar um --account-id valor em vez de um --host valor.

--profile string

Perfil para obter auth env para

Bandeiras globais

Exemplos

O exemplo a seguir obtém o ambiente de autenticação padrão:

databricks auth env

O exemplo a seguir obtém o ambiente de autenticação para um host específico:

databricks auth env --host https://my-workspace.cloud.databricks.com

A saída para um perfil configurado com a autenticação de token de acesso do Azure 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 obtém o ambiente de autenticação para um perfil específico:

databricks auth env --profile my-test-environment

Faça login em um espaço de trabalho ou conta do Databricks e salve a configuração de autenticação em um perfil (por ~/.databrickscfg padrão). O perfil pode ser usado para autenticar outros comandos da CLI do Databricks usando o --profile sinalizador. O perfil também pode ser usado para autenticar outras ferramentas Databricks que suportam autenticação unificada Databricks, incluindo os SDKs Databricks Python, Java e Go.

databricks auth login HOST [flags]

Este comando requer uma URL de host Databricks (usando --host ou como um argumento posicional ou implicitamente inferido a partir do nome de perfil especificado) e um nome de perfil (usando --profile) para ser especificado. Se você não especificar esses valores, será solicitado que você forneça valores em tempo de execução.

Embora esse comando sempre faça login no host especificado, o comportamento depende dos perfis existentes que você definiu no arquivo de configuração (por ~/.databrickscfg padrão):

Se existir um perfil com o nome especificado e especificar um host, você será conectado ao host especificado pelo perfil. O perfil será atualizado para usar "databricks-cli" como o tipo de autenticação se esse não era o caso antes.
Se existir um perfil com o nome especificado, mas não especificar um anfitrião, ser-lhe-á pedido que especifique um anfitrião. O perfil será atualizado para usar o host especificado. O tipo de autenticação será atualizado para "databricks-cli" se esse não era o caso antes.
Se existir um perfil com o nome especificado e especificar um host, mas você especificar um host usando --host (ou como o HOST arg posicional), o perfil será atualizado para usar o host recém-especificado. O tipo de autenticação será atualizado para "databricks-cli" se esse não era o caso antes.
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 Databricks (opcional)

Opções

--configure-cluster

Prompts para configurar o cluster (computação clássica)

--configure-serverless

Prompts para configurar a computação sem servidor

--timeout duration

Tempo limite para completar o desafio de login no navegador (padrão 1h0m0s)

Bandeiras globais

Exemplos

O exemplo a seguir efetua login em um espaço de trabalho Databricks:

databricks auth login

O exemplo a seguir efetua login em um espaço de trabalho específico do Databricks:

databricks auth login https://my-workspace.cloud.databricks.com

O exemplo a seguir efetua login com um perfil específico e define as configurações do cluster:

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

perfis de autenticação databricks

Liste todos os perfis de configuração disponíveis (por ~/.databrickscfg padrão) e verifique se eles são perfis válidos.

databricks auth profiles [flags]

Este comando gera 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, a CLI do Databricks lista espaços de trabalho para cada perfil no nível da conta e executa um comando get current user para cada perfil no nível do espaço de trabalho. Se o comando for bem-sucedido, um será exibido, caso YES contrário, um NO será exibido.

A saída do comando não exibe nenhum token de auth profiles acesso. Para exibir um token de acesso, consulte databricks auth env.

Por padrão, os perfis de configuração são armazenados no arquivo ~/.databrickscfg no Linux ou macOS, ou %USERPROFILE%\.databrickscfg no Windows. Você pode alterar o caminho padrão desse arquivo definindo a variável DATABRICKS_CONFIG_FILEde ambiente .

Para criar perfis de configuração, consulte o configure comando.

Opções

--skip-validate

Se deve ignorar a validação dos perfis

Bandeiras globais

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

Token de autenticação Databricks

Obtenha o token de autenticação do cache local em ~/.databricks/token-cache.json. Atualize o token de acesso se ele tiver expirado. Este comando só funciona com autenticação U2M (usando o databricks auth login comando). A autenticação M2M usando um ID de cliente e segredo não é suportada.

databricks auth token [HOST] [flags]

Para configurar e configurar a autenticação U2M do OAuth, consulte Autenticação de usuário para máquina (U2M) do OAuth.

Argumentos

HOST

URL do Host Databricks (opcional)

Opções

--account-id string

ID da conta Databricks

--timeout duration

Tempo limite para adquirir um token. (padrão 1h0m0s)

Bandeiras globais

Exemplos

O exemplo a seguir obtém o token de autenticação:

databricks auth token

O exemplo a seguir obtém o token 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 aquisição de token:

databricks auth token --timeout 30m

Bandeiras globais

--debug

Se o log de depuração deve ser habilitado.

-h ou --help

Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

Uma cadeia de caracteres que representa o ficheiro onde os registos de saída são gravados. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

O tipo de formato de log, text ou json. O valor predefinido é text.

--log-level string

Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

O nome do perfil no arquivo ~/.databrickscfg a usar para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

Se aplicável, o destino do pacote a ser usado

Feedback

Esta página foi útil?

Last updated on 2025-10-24

Partilhar via

auth grupo de comando

databricks auth descrever

Opções

Exemplos

databricks auth env |

Opções

Exemplos

Databricks Auth Login

Argumentos

Opções

Exemplos

perfis de autenticação databricks

Opções

Exemplos

Token de autenticação Databricks

Argumentos

Opções

Exemplos

Bandeiras globais

Feedback

Recursos adicionais

`auth` grupo de comando