Interfejs wiersza polecenia grup (starsza wersja)

Artykuł
05/03/2024

Ważne

Ta dokumentacja została wycofana i może nie zostać zaktualizowana.

Te informacje dotyczą starszych wersji interfejsu wiersza polecenia usługi Databricks w wersji 0.18 i poniżej. Usługa Databricks zaleca użycie nowszego interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Zobacz Co to jest interfejs wiersza polecenia usługi Databricks?. Aby znaleźć swoją wersję interfejsu wiersza polecenia usługi Databricks, uruchom polecenie databricks -v.

Aby przeprowadzić migrację z interfejsu wiersza polecenia usługi Databricks w wersji 0.18 lub nowszej do interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej, zobacz Migracja interfejsu wiersza polecenia usługi Databricks.

Uwaga

Interfejs wiersza polecenia grup wymaga interfejsu wiersza polecenia usługi Databricks w wersji 0.8.0 lub nowszej.
Aby wywołać ten interfejs API, musisz być administratorem usługi Databricks.

Uruchamiasz polecenia interfejsu wiersza polecenia grup usługi Databricks, dołączając je do databricks groupspolecenia . Te podpolecenia wywołają interfejs API grup.

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.

Dodawanie członka do grupy

Aby wyświetlić dokumentację użycia, uruchom polecenie 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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Tworzenie grupy

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks groups create --help.

databricks groups create --group-name sql-users

{
  "group_name": "sql-users"
}

Usuwanie grupy

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks groups delete --help.

databricks groups delete --group-name sql-users

{}

Wyświetlanie listy dostępnych grup

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks groups list --help.

databricks groups list

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

Wyświetlanie listy członków grupy

Aby wyświetlić dokumentację użycia, uruchom polecenie 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"
    }
  ]
}

Wyświetlanie listy grup, do których należy użytkownik lub grupa

Aby wyświetlić dokumentację użycia, uruchom polecenie 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"
  ]
}

Usuwanie członka z grupy

Aby wyświetlić dokumentację użycia, uruchom polecenie 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