`auth` grupo de comando

nota

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

dica

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.

Bandeiras globais

Exemplos

O exemplo a seguir descreve a configuração de autenticação atual:

Bash
databricks auth describe

Output
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.

Bash
databricks auth describe --host https://<workspace-instance-name>

Output
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.gcp.databricks.com.

Bash
databricks auth describe --host <account-console-url>

Output
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:

Bash
databricks auth describe -p TEST

Output
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:

Bash
databricks auth describe --sensitive

Output
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

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]

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.

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

nota

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

Bandeiras globais

Exemplos

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

Bash
databricks auth env

O exemplo a seguir mostra o ambiente de autenticação de um host específico:

Bash
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:

JSON
{
  "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:

Bash
databricks auth env --profile my-test-environment

Faça login em um Databricks workspace ou account e salve a configuração de autenticação em um perfil (em ~/.databrickscfg ou default). O perfil pode então ser usado para autenticar outros comandos Databricks CLI usando o sinalizador --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 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 posicional HOST), 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)

Bandeiras globais

Exemplos

O exemplo a seguir logs em Databricks workspace:

Bash
databricks auth login

O exemplo a seguir logs em um Databricks específico workspace:

Bash
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:

Bash
databricks auth login --profile my-profile --configure-cluster

O exemplo a seguir define um tempo limite personalizado para o processo de login:

Bash
databricks auth login --timeout 30m

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

Bandeiras globais

Exemplos

O exemplo a seguir lista todos os perfis de autenticação:

Bash
databricks auth profiles

O exemplo a seguir lista perfis sem validá-los:

Bash
databricks auth profiles --skip-validate

tokens de autenticação do Databricks

Obtenha os tokens de autenticação do cache local em ~/.databricks/token-cache.json. Atualize os tokens de acesso caso estejam expirados. Este comando funciona apenas com autenticação U2M (utilizando o comando databricks auth login ). A autenticação M2M usando um ID de cliente e um segredo não é suportada.

databricks auth token [HOST] [flags]

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

Argumentos

HOST

URL do host do Databricks (opcional)

Opções

--account-id string

Databricks ID da conta

--timeout duration

Tempo limite para aquisição de tokens. (default 1h0m0s)

Bandeiras globais

Exemplos

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

Bash
databricks auth token

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

Bash
databricks auth token https://my-workspace.cloud.databricks.com

A saída pode ser:

JSON
{
  "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:

Bash
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

descrição da autenticação do databricks​

Opções​

Exemplos​

ambiente de autenticação do databricks​

Opções​

Exemplos​

login de autenticação do databricks​

Argumentos​

Opções​

Exemplos​

perfis de autenticação do databricks​

Opções​

Exemplos​

tokens de autenticação do Databricks​

Argumentos​

Opções​

Exemplos​

Bandeiras globais​

descrição da autenticação do databricks

Opções

Exemplos

ambiente de autenticação do databricks

Opções

Exemplos

login de autenticação do databricks

Argumentos

Opções

Exemplos

perfis de autenticação do databricks

Opções

Exemplos

tokens de autenticação do Databricks

Argumentos

Opções

Exemplos

Bandeiras globais