CLI de grupos (heredada)

Importante

Esta documentación se ha retirado y es posible que no se actualice.

Esta información se aplica a las versiones heredadas 0.18 e inferiores de la CLI de Databricks. En su lugar, Databricks recomienda usar la versión más reciente 0.205 o posterior de la CLI de Databricks. Consulte ¿Qué es la CLI de Databricks?. Para encontrar su versión de la CLI de Databricks, ejecute databricks -v.

Para migrar de la versión 0.18 o inferior a la versión 0.205 o superior de la CLI de Databricks, vea Migración de la CLI de Databricks.

Nota:

• La CLI de grupos requiere la CLI de Databricks 0.8.0 o versiones posteriores.
• Debe ser administrador de Databricks para invocar esta API.

Para ejecutar subcomandos de la CLI de grupos de Databricks, anéxelos a databricks groups. Estos subcomandos llaman a la API de grupos.

databricks groups --help

Usage: databricks groups [OPTIONS] COMMAND [ARGS]...

  Provide utility to interact with Databricks groups.

Options:
  -v, --version   0.8.0
  --debug         Debug Mode. Shows full stack trace on error.
  --profile TEXT  CLI connection profile to use. The default profile is "DEFAULT".
  -h, --help      Show this message and exit.

Commands:
  add-member     Add an existing principal to another existing group.
    Options:
      --parent-name TEXT  Name of the parent group to which the new member will be
                          added. This field is required.  [required]
      --user-name TEXT    The user name which will be added to the parent group.
      --group-name TEXT   If group name which will be added to the parent group.
  create         Create a new group with the given name.
    Options:
      --group-name TEXT  [required]
  delete         Remove a group from this organization.
    Options:
      --group-name TEXT  [required]
  list           Return all of the groups in a workspace.
  list-members   Return all of the members of a particular group.
    Options:
      --group-name TEXT  [required]
  list-parents   Retrieve all groups in which a given user or group is a member.
    Options:
      --user-name TEXT
      --group-name TEXT
  remove-member  Removes a user or group from a group.
    Options:
      --parent-name TEXT  Name of the parent group to which the new member will be
                          removed. This field is required.  [required]
      --user-name TEXT    The user name which will be removed from the parent
                          group.
      --group-name TEXT   If group name which will be removed from the parent
                          group.

Adición de miembros a un grupo

Para mostrar la documentación de uso, ejecute databricks groups add-member --help.

databricks groups add-member \
--parent-name sql-users \
--user-name someone@example.com

databricks groups add-member \
--parent-name sql-power-users \
--group-name sql-users

Si se ejecuta correctamente, no se muestra ninguna salida.

Creación de un grupo

Para mostrar la documentación de uso, ejecute databricks groups create --help.

databricks groups create --group-name sql-users

{
  "group_name": "sql-users"
}

Eliminar un grupo

Para mostrar la documentación de uso, ejecute databricks groups delete --help.

databricks groups delete --group-name sql-users

{}

Enumeración de los grupos disponibles

Para mostrar la documentación de uso, ejecute databricks groups list --help.

databricks groups list

{
  "group_names": [
    "sql-users",
    "sql-power-users",
    "sql-admins"
  ]
}

Enumeración de los miembros de un grupo

Para mostrar la documentación de uso, ejecute databricks groups list-members --help.

databricks groups list-members --group-name sql-users

{
  "members": [
    {
      "user_name": "someone@example.com"
    }
  ]
}

databricks groups list-members --group-name sql-power-users

{
  "members": [
    {
      "group_name": "sql-users"
    }
  ]
}

Enumeración de los grupos a los que pertenece un usuario o grupo

Para mostrar la documentación de uso, ejecute databricks groups list-parents --help.

databricks groups list-parents --user-name someone@example.com

{
  "group_names": [
    "sql-users"
  ]
}

databricks groups list-parents --group-name sql-users

{
  "group_names": [
    "sql-power-users"
  ]
}

Eliminación de un miembro de un grupo

Para mostrar la documentación de uso, ejecute databricks groups remove-member --help.

databricks groups remove-member \
--parent-name sql-power-users \
--group-name sql-users

databricks groups remove-member \
--parent-name sql-users \
--user-name someone@example.com

Si se ejecuta correctamente, no se muestra ninguna salida.