Grupo de comandos secrets

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 secrets grupo de comandos de la CLI de Databricks permite administrar secretos, ámbitos secretos y permisos de acceso. A veces, el acceso a los datos requiere que se autentique en orígenes de datos externos a través de JDBC. En lugar de escribir directamente las credenciales en un cuaderno, use secretos de Databricks para almacenar sus credenciales y hacer referencia a ellas en cuadernos y trabajos. Consulte Administración de secretos.

databricks secrets create-scope

Cree un nuevo ámbito de secreto.

El nombre del ámbito debe constar de caracteres alfanuméricos, guiones, caracteres de subrayado y puntos, y no puede superar los 128 caracteres.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Nombre de ámbito solicitado por el usuario. Los nombres de los ámbitos son únicos.

Options

--initial-manage-principal string

    Entidad de seguridad a la que inicialmente se le ha concedido el permiso MANAGE en el ámbito creado.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--scope-backend-type ScopeBackendType

    Tipo de back-end con el que se creará el ámbito. Valores admitidos: AZURE_KEYVAULT, DATABRICKS

Marcas globales

databricks secrets delete-acl

Elimine la ACL proporcionada en el ámbito especificado.

Los usuarios deben tener el MANAGE permiso para invocar este comando. Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto, una entidad de seguridad o una ACL de este tipo. Produce PERMISSION_DENIED si el usuario no tiene permiso para realizar esta llamada API.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nombre del ámbito del que se van a quitar los permisos.

PRINCIPAL

    Entidad de seguridad de la que se va a quitar una ACL existente.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

Marcas globales

databricks secretos eliminar-alcance

Elimine un ámbito de secreto.

Se produce RESOURCE_DOES_NOT_EXIST si el ámbito no existe. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Nombre del ámbito que se va a eliminar.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

Marcas globales

databricks secrets delete-secret - Comando para eliminar un secreto almacenado en Databricks.

Elimine el secreto almacenado en este ámbito privado. Debe tener el permiso WRITE o MANAGE en el ámbito de secreto.

Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto o un secreto de este tipo. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nombre del ámbito que contiene el secreto que se va a eliminar.

KEY

    Nombre del secreto que se va a eliminar.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

Marcas globales

databricks secrets get-acl

Obtenga los detalles sobre la ACL proporcionada, como el grupo y el permiso. Los usuarios deben tener el MANAGE permiso para invocar esta API.

Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto de este tipo. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nombre del ámbito del que se va a recuperar la información de la ACL.

PRINCIPAL

    Entidad de seguridad de la que se va a recuperar la información de la ACL.

Options

Marcas globales

databricks secrets get-secret

Obtenga la representación en bytes de un valor secreto para el ámbito y la clave especificados.

Los usuarios necesitan el READ permiso para realizar esta llamada.

Tenga en cuenta que el valor secreto devuelto está en bytes. La interpretación de los bytes viene determinada por el autor de la llamada en DBUtils y el tipo en el que se descodifican los datos.

Produce PERMISSION_DENIED si el usuario no tiene permiso para realizar esta llamada API. Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto o secreto de este tipo.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nombre del ámbito del que se va a obtener información secreta.

KEY

    Clave para obtener el secreto.

Options

Marcas globales

databricks secrets list-acls

Enumere las ACL de un ámbito secreto determinado. Los usuarios deben tener el MANAGE permiso para invocar esta API.

Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto de este tipo. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Nombre del ámbito del que se va a recuperar la información de la ACL.

Options

Marcas globales

databricks secrets list-scopes

Enumere todos los ámbitos secretos disponibles en el área de trabajo.

Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets list-scopes [flags]

Options

Marcas globales

databricks secrets list-secrets (comando para listar secretos en Databricks)

Enumere las claves secretas que se almacenan en este ámbito. Se trata de una operación de solo metadatos; los datos secretos no se pueden recuperar mediante este comando. Los usuarios necesitan el READ permiso para realizar esta llamada.

El lastUpdatedTimestamp devuelto se encuentra en milisegundos desde la Época. Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto de este tipo. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Nombre del ámbito en el que se van a enumerar los secretos.

Options

Marcas globales

databricks secrets put-acl

Cree o sobrescriba la lista de control de acceso (ACL) asociada al principal especificado (usuario o grupo) en el punto de ámbito designado.

En general, un usuario o grupo usará el permiso más eficaz disponible para ellos y los permisos se ordenan de la siguiente manera:

• MANAGE Se permite cambiar las ACL y leer y escribir en este ámbito de secreto.
• WRITE Se permite leer y escribir en este ámbito de secreto.
• READ Se permite leer este ámbito de secreto y enumerar qué secretos hay disponibles.

Tenga en cuenta que, en general, los valores secretos solo se pueden leer desde dentro de un comando de un clúster (por ejemplo, a través de un cuaderno). No hay ninguna API para leer el material de valor secreto real fuera de un clúster. Sin embargo, el permiso del usuario se aplicará en función de quién ejecuta el comando y debe tener al menos el permiso READ.

Los usuarios deben tener el MANAGE permiso para invocar este comando.

El principal es un nombre de usuario o de grupo que corresponde a un principal existente de Databricks al que se le concederá o revocará el acceso.

Se produce RESOURCE_DOES_NOT_EXIST si no existe un ámbito de secreto de este tipo. Se produce RESOURCE_ALREADY_EXISTS si ya existe un permiso para la entidad de seguridad. Genera INVALID_PARAMETER_VALUE si el permiso o el principal no son válidos. Lanza PERMISSION_DENIED si el usuario no tiene permiso para efectuar esta llamada.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Nombre del ámbito al que se van a aplicar permisos.

PRINCIPAL

    Entidad de seguridad en la que se aplica el permiso.

PERMISSION

    Nivel de permiso aplicado a la entidad de seguridad. Valores admitidos: MANAGE, READ, WRITE.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

Marcas globales

secretos de databricks put-secret

Inserte un secreto en el ámbito proporcionado con el nombre especificado. Si ya existe un secreto con el mismo nombre, este comando sobrescribe el valor del secreto existente. El servidor cifra el secreto mediante la configuración de cifrado del ámbito del secreto antes de almacenarlo.

Debe tener el permiso WRITE o MANAGE en el ámbito de secreto. La clave secreta debe constar de caracteres alfanuméricos, guiones, caracteres de subrayado y puntos, y no puede superar los 128 caracteres. El tamaño máximo permitido del valor del secreto es de 128 KB. El número máximo de secretos en un ámbito determinado es 1000.

Los argumentos string-value o bytes-value especifican el tipo del secreto, que determinará el valor devuelto cuando se solicite el valor secreto.

Puede especificar el valor del secreto de una de estas tres maneras:

• Especifique el valor como una cadena mediante la --string-value marca .
• Escriba el secreto cuando se le solicite de forma interactiva (secretos de una sola línea).
• Pase el secreto a través de la entrada estándar (secretos de varias líneas).

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nombre del ámbito en el que se va a almacenar el secreto.

KEY

    Nombre de la clave del secreto.

Options

--bytes-value string

    Si se especifica, el valor se almacenará como bytes.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--string-value string

    Si se especifica, tenga en cuenta que el valor se almacenará en formato UTF-8 (MB4).

Marcas globales

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

    El tipo de salida del comando, ya sea text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg para usarlo al 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 es aplicable, el objetivo del paquete que se va a usar