群組 CLI （舊版）

重要

此文件已淘汰且可能不再更新。

此資訊適用於舊版 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 或更新版本。
• 您必須是 Databricks 系統管理員，才能叫用此 API。

您可以藉由將它們附加至 databricks groups來執行 Databricks 群組 CLI 子命令。 這些子命令會呼叫 群組 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

如果成功，就不會顯示任何輸出。