Grupo de comandos auth

Note

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 auth grupo de comandos de la CLI de Databricks contiene comandos relacionados con la autenticación, incluidos los siguientes:

  • 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.
  • Cierre la sesión de un perfil borrando los tokens de OAuth almacenados en caché y, opcionalmente, quitando la entrada del perfil.
  • 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.

Tip

Para obtener información sobre el usuario actual de la CLI de Databricks, ejecute databricks current-user me.

Descripción de la autenticación de databricks

Describe la configuración que usa la CLI de Databricks para autenticarse, incluidas las credenciales y el origen de esas credenciales. Si no se especifica ninguna opción, el auth describe comando sigue la prioridad del método de autenticación.

databricks auth describe [flags]

Opciones

--sensitive

    Incluir campos confidenciales como contraseñas y tokens en la salida

Marcas globales

Ejemplos

En el ejemplo siguiente se describe la configuración de autenticación actual:

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

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

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 de Azure Databricks específico, especifique la -p opción o --profile junto con el nombre del 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 información confidencial en la salida (como tokens de acceso personal de Azure Databricks y secretos de cliente), especifique la --sensitive opción:

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

entorno de autenticación de databricks

Warning

Este comando está en desuso.

Obtenga información sobre un perfil de configuración existente mediante el nombre del perfil o 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.

databricks auth env [flags]

Tip

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.

Para crear un perfil de configuración, consulte el configure comando .

Opciones

--host string

    Nombre de host para obtener la autenticación env para

Note

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.

--profile string

    Perfil para obtener la autenticación env para

Marcas globales

Ejemplos

En el ejemplo siguiente se obtiene el entorno de autenticación predeterminado:

databricks auth env

En el ejemplo siguiente se obtiene el entorno de autenticación de un host específico:

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

La salida de un perfil configurado con la autenticación de tokens de acceso de Azure Databricks podría ser:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

En el ejemplo siguiente se obtiene el entorno de autenticación de un perfil específico:

databricks auth env --profile my-test-environment

inicio de sesión de autenticación de databricks

Inicie sesión en un área de trabajo o cuenta de Databricks y guarde la configuración de autenticación en un perfil (de ~/.databrickscfg forma predeterminada). A continuación, el perfil se puede usar para autenticar otros comandos de la CLI de Databricks mediante la --profile marca . El perfil también se puede usar para autenticar otras herramientas de Databricks que admiten la autenticación unificada de Databricks, incluidos los SDK de Python, Java y Go de Databricks.

databricks auth login HOST [flags]

Este comando requiere una dirección URL de host de Databricks (mediante --host o como argumento posicional o inferida implícitamente del nombre de perfil especificado) y un nombre de perfil (mediante --profile) que se va a especificar. Si no especifica estos valores, se le pedirán valores en tiempo de ejecución.

Aunque este comando siempre inicia sesión en el host especificado, el comportamiento depende de los perfiles existentes que haya establecido en el archivo de configuración (de ~/.databrickscfg forma predeterminada):

  1. Si existe un perfil con el nombre especificado y especifica un host, se le registrará en el host especificado por el perfil. El perfil se actualizará para usar "databricks-cli" como tipo de autenticación si no era el caso anterior.
  2. Si existe un perfil con el nombre especificado pero no especifica un host, se le pedirá que especifique un host. El perfil se actualizará para usar el host especificado. El tipo de autenticación se actualizará a "databricks-cli" si no era el caso anterior.
  3. Si existe un perfil con el nombre especificado y especifica un host, pero especifica un host mediante --host (o como HOST argumento posicional), el perfil se actualizará para usar el host recién especificado. El tipo de autenticación se actualizará a "databricks-cli" si no era el caso anterior.
  4. Si no existe un perfil con el nombre especificado, se creará un nuevo perfil con el host especificado. El tipo de autenticación se establecerá en "databricks-cli".

Argumentos

HOST

    Dirección URL del host de Databricks (opcional)

Opciones

--configure-cluster

    Solicitudes para configurar el clúster (cómputo clásico)

--configure-serverless

    Instrucciones para configurar el cómputo sin servidor

--timeout duration

    Tiempo de espera para completar el desafío de inicio de sesión en el explorador (1h0m0s predeterminado)

Marcas globales

Ejemplos

En el ejemplo siguiente se inicia sesión en un área de trabajo de Databricks:

databricks auth login

En el ejemplo siguiente se registran en un área de trabajo específica de Databricks:

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

En el ejemplo siguiente se registra con un perfil específico y se configuran las opciones de clúster:

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

En el ejemplo siguiente se establece un tiempo de espera personalizado para el proceso de inicio de sesión:

databricks auth login --timeout 30m

cierre de sesión de autenticación de databricks

Cierre sesión en un perfil de Azure Databricks borrando sus tokens de OAuth almacenados en caché. Tendrá que ejecutar databricks auth login para volver a autenticarse. El perfil permanece en el archivo de configuración (~/.databrickscfg de forma predeterminada) a menos que también especifique --delete.

databricks auth logout [PROFILE] [flags]

Este comportamiento solo se aplica a los perfiles creados con databricks auth login (auth_type establecido en databricks-cli). Los perfiles que usan otros métodos de autenticación, como tokens de acceso personal o credenciales de máquina a máquina, no almacenan tokens de OAuth almacenados en caché, por lo que no hay nada que borrar. Si varios perfiles comparten el mismo token almacenado en caché, el registro de uno no afecta a los demás.

Comportamiento del comando:

  1. Si especifica un perfil (como argumento PROFILE o con --profile), el comando cierra sesión de ese perfil. También puede proporcionar una dirección URL de host, que el comando se resuelve en el perfil coincidente. En un terminal interactivo, solicita confirmación a menos que también especifique --auto-approve.
  2. Si omite el perfil en un terminal interactivo, el comando muestra un selector de perfil que se puede buscar. Puede buscar por nombre de perfil, host o identificador de cuenta. Después de seleccionar un perfil, el comando solicita confirmación a menos que también especifique --auto-approve.
  3. Si omite el perfil en un entorno no interactivo, se produce un error en el comando y se le pide que especifique un perfil.
  4. En un entorno no interactivo, especifique un perfil junto con --auto-approve para omitir la confirmación.

Argumentos

PROFILE

    Nombre de perfil o dirección URL de host para cerrar sesión (opcional). El argumento se compara primero con los nombres de perfil existentes. Si ningún perfil coincide y el argumento es similar a una dirección URL de host, el comando lo resuelve en los perfiles configurados para ese host. Si varios perfiles coinciden con un host, el sistema le pedirá que seleccione uno (o errores en modo no interactivo).

Opciones

--delete

    Quite también el perfil del archivo de configuración (~/.databrickscfg de forma predeterminada)

--auto-approve

    Omitir el mensaje de confirmación

Marcas globales

Ejemplos

En el ejemplo siguiente se cierra la sesión de un perfil específico:

databricks auth logout my-profile

En el ejemplo siguiente se cierra la sesión del perfil asociado a una dirección URL de host:

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

En el ejemplo siguiente se cierra la sesión y se quita el perfil del archivo de configuración:

databricks auth logout --profile my-profile --delete

En el ejemplo siguiente se cierra sesión sin un mensaje de confirmación, adecuado para CI/CD:

databricks auth logout my-profile --auto-approve

perfiles de autenticación de databricks

Enumere todos los perfiles de configuración disponibles (de ~/.databrickscfg forma predeterminada) y compruebe si son perfiles válidos.

databricks auth profiles [flags]

Este comando genera perfiles en el formato siguiente:

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 enumera las áreas de trabajo de cada perfil de nivel de cuenta y ejecuta un comando get current user 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 auth profiles comando no muestra ningún token de acceso. Para mostrar un token de acceso, consulte databricks auth env.

De forma predeterminada, los perfiles de configuración se almacenan en el archivo ~/.databrickscfg en Linux o macOS, o %USERPROFILE%\.databrickscfg en Windows. Puede cambiar la ruta predeterminada del archivo configurando la variable de entorno DATABRICKS_CONFIG_FILE.

Para crear perfiles de configuración, consulte el configure comando .

Opciones

--skip-validate

    Si se omite la validación de los perfiles

Marcas globales

Ejemplos

En el ejemplo siguiente se enumeran todos los perfiles de autenticación:

databricks auth profiles

En el ejemplo siguiente se enumeran los perfiles sin validarlos:

databricks auth profiles --skip-validate

conmutador de autenticación de databricks

Establezca un perfil con nombre como predeterminado en ~/.databrickscfg. El nombre del perfil seleccionado se almacena en una [__settings__] sección del archivo de configuración bajo la default_profile clave. Use databricks auth profiles para ver qué perfil es actualmente el valor predeterminado.

databricks auth switch [flags]

Opciones

Marcas globales

Ejemplos

En el ejemplo siguiente se selecciona de forma interactiva un perfil para establecerlo como valor predeterminado:

databricks auth switch

En el ejemplo siguiente se establece un perfil específico como predeterminado:

databricks auth switch --profile my-profile

token de autenticación de databricks

Obtenga el token de autenticación de la memoria caché local en ~/.databricks/token-cache.json. Actualice el token de acceso si ha expirado o está cerca de la expiración. Este comando solo funciona con la autenticación U2M (mediante el databricks auth login comando ). No se admite la autenticación de M2M mediante un identificador de cliente y un secreto.

databricks auth token [HOST_OR_PROFILE] [flags]

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

Argumentos

HOST_OR_PROFILE

    Dirección URL de host o nombre de perfil de Databricks (opcional)

Opciones

--account-id string

    Identificador de cuenta de Databricks

--force-refresh

    Forzar una actualización de token incluso si el token almacenado en caché sigue siendo válido.

--timeout duration

    Tiempo de espera para adquirir un token. (valor predeterminado 1h0m0s)

Marcas globales

Ejemplos

En el ejemplo siguiente se obtiene el token de autenticación:

databricks auth token

En el ejemplo siguiente se obtiene el token de autenticación de un host específico:

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

La salida puede ser:

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

En el ejemplo siguiente se establece un tiempo de espera personalizado para la adquisición de tokens:

databricks auth token --timeout 30m

Marcas globales

--debug

  Indica si se va a habilitar el registro de depuración.

-h o --help

    Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.

--log-file cadena

    Cadena que representa el archivo en el que se van a escribir registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.

--log-format formato

    Tipo de formato de registro: text o json. El valor predeterminado es text.

--log-level cadena

    Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.

-o, --output tipo

    Tipo de salida del comando, text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg que se usará para ejecutar el comando. Si no se especifica esta marca, si existe, se usa el perfil denominado DEFAULT .

--progress-format formato

    Formato para mostrar los registros de progreso: default, append, inplaceo json

-t, --target cadena

    Si procede, el destino del paquete que se va a usar

  • Last updated on