Cli групп (устаревшая версия)

Статья
05/03/2024

Внимание

Поддержка этой документации прекращена, она может больше не обновляться.

Эта информация относится к устаревшим интерфейсам командной строки Databricks версии 0.18 и ниже. Databricks рекомендует использовать более новую версию Интерфейса командной строки Databricks версии 0.205 или более поздней. См. сведения о интерфейсе командной строки Databricks?. Чтобы найти версию интерфейса командной строки Databricks, выполните команду databricks -v.

Сведения о миграции из Databricks CLI версии 0.18 или ниже в Databricks CLI версии 0.205 или более поздней, см. в статье Databricks CLI.

Примечание.

Для работы с CLI групп требуется интерфейс командной строки Databricks 0.8.0 или более поздней версии.
Для вызова этого API необходимо быть администратором Databricks.

Чтобы запустить подкоманды CLI для групп Databricks, добавьте их в databricks groups. Эти вложенные команды вызывают API групп.

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.

Добавление участника в группу

Чтобы просмотреть документацию по использованию, выполните команду 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

В случае успеха отчет о выполнении команды не отображается.

Создать группу

Чтобы просмотреть документацию по использованию, выполните команду databricks groups create --help.

databricks groups create --group-name sql-users

{
  "group_name": "sql-users"
}

Удаление группы

Чтобы просмотреть документацию по использованию, выполните команду databricks groups delete --help.

databricks groups delete --group-name sql-users

{}

Просмотр списка доступных групп

Чтобы просмотреть документацию по использованию, выполните команду databricks groups list --help.

databricks groups list

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

Просмотр списка участников группы

Чтобы просмотреть документацию по использованию, выполните команду 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"
    }
  ]
}

Просмотр списка групп, к которым принадлежит пользователь или группа

Чтобы просмотреть документацию по использованию, выполните команду 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"
  ]
}

Удаление члена из группы

Чтобы просмотреть документацию по использованию, выполните команду 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