Compartir a través de

Grupo de comandos de auth

  • Artículo

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El authgrupo de comandos dentro de la CLI de Databricks le permite:

  • Enumere los perfiles de configuración de autenticación disponibles.
  • Obtenga información sobre un perfil de configuración de autenticación individual.
  • Use la autenticación de usuario a máquina (U2M) de OAuth para autenticar la CLI de Databricks con las cuentas y áreas de trabajo de Azure Databricks.
  • Obtenga información sobre los tokens de acceso de OAuth que la CLI de Databricks podría haber almacenado en caché.
  • Obtenga detalles sobre la configuración que usa la CLI de Databricks para autenticarse.

Ejecute los comandos auth anexándolos a databricks auth. A fin de mostrar la ayuda para este comando auth, ejecute databricks auth -h.

Enumerar perfiles de configuración

Para obtener una lista de todos los perfiles de configuración disponibles y comprobar si son válidos, ejecute el comando auth profiles de la siguiente manera:

databricks auth profiles

Salida (los puntos suspensivos representan contenido omitido, por brevedad):

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

Para determinar si cada perfil es válido, la CLI de Databricks ejecuta un comando para listar áreas de trabajo para cada perfil de nivel de cuenta y ejecuta un comando para obtener el usuario actual para cada perfil de nivel de área de trabajo. Si el comando se ejecuta correctamente, se muestra un YES; de lo contrario, se muestra NO.

La salida del comando auth profiles no muestra ningún token de acceso. Para mostrar un token de acceso, consulte Obtenga información sobre un perfil de configuración.

Los perfiles de configuración se almacenan en el archivo ~/.databrickscfg en Linux o macOS, o %USERPROFILE%\.databrickscfg en Windows, de manera predeterminada. Puede cambiar la ruta predeterminada del archivo configurando la variable de entorno DATABRICKS_CONFIG_FILE. Para aprender cómo establecer estas variables de entorno, consulte la documentación del sistema operativo.

Para crear perfiles de configuración, consulte configurar grupo de comandos.

Obtener información sobre los perfiles de configuración

Para obtener información sobre un perfil de configuración existente, ejecute el comando auth env, donde <profile-name> representa el nombre del perfil y <account-or-workspace-url> representa la dirección URL de la consola de la cuenta de Azure Databricks o la dirección URL del área de trabajo de Azure Databricks, como se indica a continuación:

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

Sugerencia

Puede presionar Tab después de --profile o -p para mostrar una lista de perfiles de configuración disponibles entre los que elegir, en lugar de escribir manualmente el nombre del perfil de configuración.

Por ejemplo, este es el resultado de un perfil configurado con la autenticación del token de acceso de Azure Databricks:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Nota:

Si más de un perfil coincide con el valor --host, se muestra un error que indica que no encuentra un único perfil coincidente. Por ejemplo, puede tener un perfil que solo tenga un valor de host y otro perfil que tenga el mismo valor de host, pero también un valor de token. En este caso, la CLI de Databricks no elige ningún perfil y se detiene. Para ayudar a la CLI de Databricks a elegir el perfil deseado, pruebe a especificar un valor --host diferente. En el caso de los valores --host que son direcciones URL de la consola de cuenta, intente especificar un valor --account-id en lugar de un valor --host.

Para crear perfiles de configuración, consulte configurar grupo de comandos.

Autenticar con OAuth

En lugar de autenticarse con Azure Databricks mediante tokens de acceso y perfiles de configuración, puede usar la autenticación de usuario a máquina (U2M) de OAuth. OAuth proporciona tokens con tiempos de expiración más rápidos que los tokens de acceso personal de Azure Databricks y ofrece una mejor invalidación y ámbito de sesión del lado servidor. Dado que los tokens de acceso de OAuth expiran en menos de una hora, esto reduce el riesgo asociado a la comprobación accidental de tokens en el control de código fuente. Consulte Autenticación del acceso a Azure Databricks con una cuenta de usuario mediante OAuth (OAuth M2M).

Para configurar y configurar la autenticación U2M de OAuth, vea autenticación de usuario a máquina (U2M) de OAuth.

Obtención de los detalles del token de acceso de OAuth

Si desea ver información sobre el token de acceso de OAuth almacenado en caché que la CLI de Databricks generó anteriormente para un área de trabajo de Azure Databricks, ejecute el auth tokencomando, donde <workspace-url> representa la dirección URL del área de trabajo de Azure Databricks, como se indica a continuación:

databricks auth token <workspace-url>

Salida:

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

Obtener detalles de autenticación

Para obtener detalles sobre la configuración que usa la CLI de Databricks para autenticarse, ejecute el comando auth describe.

Si no se especifica ninguna opción, el comando auth describe sigue los Métodos predeterminados para la autenticación unificada del cliente.

databricks auth describe

Salida:

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 se usa información sobre un área de trabajo de Azure Databricks específica, especifique la opción --host junto con la dirección URL del área de trabajo.

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

Salida:

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 se usa información sobre una cuenta específica de Azure Databricks, especifique la opción --host junto con la dirección URL de la consola de la cuenta de Azure Databricks, https://accounts.azuredatabricks.net.

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

Salida:

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 se usa información sobre un perfil de configuración específico de Azure Databricks, especifique la opción -p o --profile junto con el nombre del perfil.

databricks auth describe -p <profile-name>

Salida:

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 información confidencial en la salida (como tokens de acceso personal y secretos de cliente de Azure Databricks), especifique la opción --sensitive.

databricks auth describe --sensitive

Salida:

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