メインコンテンツまでスキップ

グループ CLI (レガシ)

important

このドキュメントは廃止されており、更新されない可能性があります。

この情報は、従来の Databricks CLI バージョン 0.18 以下に適用されます。 Databricks では、代わりに新しい Databricks CLI バージョン 0.205 以降を使用することをお勧めします。 「Databricks CLI とは」を参照してください。Databricks CLI のバージョンを確認するには、 databricks -vを実行します。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行するには、「 Databricks CLI の移行」を参照してください。

注記
  • グループ CLI には、Databricks CLI 0.8.0 以降が必要です。
  • この API を呼び出すには、Databricks 管理者 である必要があります。

Databricks グループの CLI サブコマンドを実行するには、それらを databricks groupsに追加します。 これらのサブコマンドは、グループ APIを呼び出します。

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.

グループにメンバーを追加する​

使用方法のドキュメントを表示するには、 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

成功した場合、出力は表示されません。

グループの作成​

使用方法のドキュメントを表示するには、 databricks groups create --helpを実行します。

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

グループを削除する​

使用方法のドキュメントを表示するには、 databricks groups delete --helpを実行します。

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

使用可能なグループを一覧表示する​

使用方法のドキュメントを表示するには、 databricks groups list --helpを実行します。

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

グループのメンバーを一覧表示する​

使用方法のドキュメントを表示するには、 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"
    }
  ]
}

ユーザーまたはグループが所属するグループを一覧表示します​

使用方法のドキュメントを表示するには、 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"
  ]
}

グループからメンバーを削除する​

使用方法のドキュメントを表示するには、 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

成功した場合、出力は表示されません。

に最終更新