Interfaccia della riga di comando dei gruppi (legacy)

Articolo
05/03/2024

Importante

Questa documentazione è stata ritirata e potrebbe non essere aggiornata.

Queste informazioni si applicano alle versioni legacy dell'interfaccia della riga di comando di Databricks 0.18 e successive. Databricks consiglia di usare invece la versione 0.205 o successiva dell'interfaccia della riga di comando di Databricks più recente. Vedere Che cos'è l'interfaccia della riga di comando di Databricks?. Per trovare la versione dell'interfaccia della riga di comando di Databricks, eseguire databricks -v.

Per eseguire la migrazione dall'interfaccia della riga di comando di Databricks versione 0.18 o successiva all'interfaccia della riga di comando di Databricks versione 0.205 o successiva, vedere Migrazione dell'interfaccia della riga di comando di Databricks.

Nota

L'interfaccia della riga di comando dei gruppi richiede l'interfaccia della riga di comando di Databricks 0.8.0 o versione successiva.
Per richiamare questa API, è necessario essere un amministratore di Databricks.

È possibile eseguire sottocomandi dell'interfaccia della riga di comando dei gruppi di Databricks aggiungendoli a databricks groups. Questi sottocomandi chiamano l'API Gruppi.

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.

Aggiungere un membro a un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire 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

In caso di esito positivo, non viene visualizzato alcun output.

Creare un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire databricks groups create --help.

databricks groups create --group-name sql-users

{
  "group_name": "sql-users"
}

Eliminare un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire databricks groups delete --help.

databricks groups delete --group-name sql-users

{}

Elencare i gruppi disponibili

Per visualizzare la documentazione sull'utilizzo, eseguire databricks groups list --help.

databricks groups list

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

Elencare i membri di un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire 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"
    }
  ]
}

Elencare i gruppi a cui appartiene un utente o un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire 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"
  ]
}

Rimuovere un membro da un gruppo

Per visualizzare la documentazione sull'utilizzo, eseguire 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