Compartilhar via

Grupo de comandos auth

Note

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 provisionamentos 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.
  • Usar a autenticação U2M (usuário para máquina) do OAuth para autenticar a CLI do Databricks com suas contas e workspaces 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.

descrever a 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 auth describe comando seguirá a prioridade do método de autenticação.

databricks auth describe [flags]

Opções

--sensitive

    Incluir campos confidenciais como senhas e tokens na saída

Sinalizadores 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 informações sobre um workspace específico do Azure Databricks sejam usadas, especifique a opção --host junto com a 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 informações sobre uma conta específica do Azure Databricks sejam usadas, especifique a opção --host juntamente com a URL do console da conta, 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 informações sobre um perfil de configuração específico do Azure Databricks sejam usadas, especifique a opção -p ou --profile a opção 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 do cliente do Azure Databricks), 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

databricks ambiente de autenticação

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 workspace do Azure Databricks.

databricks auth env [flags]

Tip

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 criar um perfil de configuração, consulte o configure comando.

Opções

--host string

    Nome do host para o qual obter auth env

Note

Se mais de um perfil corresponder ao --host valor, um erro será exibido, informando que ele não pode 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 valores --host que são URLs de console de conta, tente especificar um valor --account-id em vez de um valor --host.

--profile string

    Perfil para obter o env de autenticação para

Sinalizadores 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 de um host específico:

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

A saída de 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

logon de autenticação do databricks

Faça logon em um workspace ou conta do Databricks e salve a configuração de autenticação em um perfil (por ~/.databrickscfg padrão). Em seguida, 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 do Databricks que dão suporte à autenticação unificada do Databricks, incluindo os SDKs do Databricks Python, Java e Go.

databricks auth login HOST [flags]

Esse comando requer uma URL de host do Databricks (usando --host ou como um argumento posicional ou implicitamente inferida do nome do perfil especificado) e um nome de perfil (usando --profile) para ser especificado. Se você não especificar esses valores, será solicitado que você solicite valores em runtime.

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

  1. 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 fosse o caso antes.
  2. Se houver um perfil com o nome especificado, mas não especificar um host, será solicitado que você especifique um host. O perfil será atualizado para usar o host especificado. O tipo de autenticação será atualizado para "databricks-cli" se esse não for o caso antes.
  3. Se um perfil com o nome especificado existir 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 for o caso antes.
  4. 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 o cluster (computação clássica)

--configure-serverless

    Instruções para configurar a computação sem servidor

--timeout duration

    Tempo limite para concluir o desafio de logon no navegador (padrão de 1h0m0s)

Sinalizadores globais

Exemplos

O exemplo a seguir faz logon em um workspace do Databricks:

databricks auth login

O exemplo a seguir faz logon em um workspace específico do Databricks:

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

O exemplo a seguir faz logon 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 logon:

databricks auth login --timeout 30m

perfis de autenticação do databricks

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

databricks auth profiles [flags]

Esse 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 workspaces para cada perfil de nível de conta e executa um comando obter o usuário atual para cada perfil no nível do workspace. Se o comando for bem-sucedido, um YES será exibido; caso contrário, um NO será exibido.

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

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 de ambiente DATABRICKS_CONFIG_FILE.

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

Opções

--skip-validate

    Se ignorar a validação dos perfis

Sinalizadores 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 do databricks

Obtenha o token de autenticação do cache local em ~/.databricks/token-cache.json. Atualize o token de acesso se ele tiver expirado. Esse comando só funciona com a autenticação U2M (usando o databricks auth login comando). Não há suporte para autenticação M2M usando uma ID e um segredo do cliente.

databricks auth token [HOST] [flags]

Para configurar e definir a autenticação U2M do OAuth, saiba mais em autenticação U2M (usuário para máquina) do OAuth.

Argumentos

HOST

    URL do Host do Databricks (opcional)

Opções

--account-id string

    ID da conta do Databricks

--timeout duration

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

Sinalizadores 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

Sinalizadores globais

--debug

  Optar por habilitar o registro de log de depuração.

-h ou --help

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

--log-file corda

    Uma cadeia de caracteres que representa o arquivo onde serão gravados os logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

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

  • Last updated on