Aller au contenu principal
Dernière mise à jour le

CLI des groupes (hérité)

important

Cette documentation a été retirée et pourrait ne pas être mise à jour.

Ces informations s'appliquent aux anciennes versions de la CLI Databricks 0.18 et antérieures. Databricks vous recommande d'utiliser plutôt la version 0.205 ou ultérieure de Databricks CLI. Voir CLI Databricks. Pour trouver votre version de la CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0.18 ou inférieure vers Databricks CLI version 0.205 ou supérieure, consultez la migration de Databricks CLI.

remarque
  • La CLI Groupes requiert la CLI Databricks 0.8.0 ou une version ultérieure.
  • Vous devez être un administrateur Databricks pour invoquer cette API.

Vous exécutez les sous-commandes de groupes CLI Databricks en les ajoutant à databricks groups. Ces sous-commandes appellent l'API Groupes.

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

Ajouter un membre à un groupe​

Pour afficher la documentation d'utilisation, exécutez databricks groups add-member --help.

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

En cas de succès, aucune sortie n'est affichée.

Créer un groupe​

Pour afficher la documentation d'utilisation, exécutez databricks groups create --help.

Bash
databricks groups create --group-name sql-users
Console
{
  "group_name": "sql-users"
}

Supprimer un groupe​

Pour afficher la documentation d'utilisation, exécutez databricks groups delete --help.

Bash
databricks groups delete --group-name sql-users
Console
{}

Lister les groupes disponibles​

Pour afficher la documentation d'utilisation, exécutez databricks groups list --help.

Bash
databricks groups list
Console
{
  "group_names": [
    "sql-users",
    "sql-power-users",
    "sql-admins"
  ]
}

Lister les membres d’un groupe​

Pour afficher la documentation d'utilisation, exécutez databricks groups list-members --help.

Bash
databricks groups list-members --group-name sql-users
Console
{
  "members": [
    {
      "user_name": "someone@example.com"
    }
  ]
}
Bash
databricks groups list-members --group-name sql-power-users
Console
{
  "members": [
    {
      "group_name": "sql-users"
    }
  ]
}

Listez les groupes auxquels un utilisateur ou un groupe appartient​

Pour afficher la documentation d'utilisation, exécutez databricks groups list-parents --help.

Bash
databricks groups list-parents --user-name someone@example.com
Console
{
  "group_names": [
    "sql-users"
  ]
}
Bash
databricks groups list-parents --group-name sql-users
Console
{
  "group_names": [
    "sql-power-users"
  ]
}

Supprimer un membre d’un groupe​

Pour afficher la documentation d'utilisation, exécutez databricks groups remove-member --help.

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

En cas de succès, aucune sortie n'est affichée.

Sur cette page