Freigeben über


Gruppen-CLI (Legacy)

Wichtig

Diese Dokumentation wurde eingestellt und kann nicht aktualisiert werden.

Diese Informationen gelten für ältere Databricks CLI-Versionen 0.18 und darunter. Databricks empfiehlt, stattdessen neuere Databricks CLI-Version 0.205 oder höher zu verwenden. Siehe Was ist die Databricks CLI?. Um Ihre Version der Databricks CLI zu finden, führen Sie databricks -vaus.

Informationen zum Migrieren von Databricks CLI Version 0.18 oder darunter zu Databricks CLI, Version 0.205 oder höher, finden Sie unter Databricks CLI-Migration.

Anmerkung

  • Die Gruppen-CLI erfordert Databricks CLI 0.8.0 oder höher.
  • Sie müssen ein Databricks-Administrator sein, um diese API aufzurufen.

Sie führen Unterbefehle der Databricks-Gruppen-CLI aus, indem Sie sie an databricks groupsanhängen. Diese Unterbefehle rufen die Groups-APIauf.

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.

Hinzufügen eines Mitglieds zu einer Gruppe

Führen Sie databricks groups add-member --helpaus, um die Verwendungsdokumentation anzuzeigen.

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

Bei Erfolg wird keine Ausgabe angezeigt.

Erstellen einer Gruppe

Führen Sie databricks groups create --helpaus, um die Verwendungsdokumentation anzuzeigen.

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

Löschen einer Gruppe

Führen Sie databricks groups delete --helpaus, um die Verwendungsdokumentation anzuzeigen.

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

Verfügbare Gruppen auflisten

Führen Sie databricks groups list --helpaus, um die Verwendungsdokumentation anzuzeigen.

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

Auflisten der Mitglieder einer Gruppe

Führen Sie databricks groups list-members --helpaus, um die Verwendungsdokumentation anzuzeigen.

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"
    }
  ]
}

Auflisten der Gruppen, zu denen ein Benutzer oder eine Gruppe gehört

Führen Sie databricks groups list-parents --helpaus, um die Verwendungsdokumentation anzuzeigen.

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"
  ]
}

Entfernen eines Mitglieds aus einer Gruppe

Führen Sie databricks groups remove-member --helpaus, um die Verwendungsdokumentation anzuzeigen.

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

Bei Erfolg wird keine Ausgabe angezeigt.