群組 API 2.0

群組 API 可讓您管理使用者群組。

注意

您必須是 Azure Databricks 系統管理員 ,才能叫用此 API。

重要

若要存取 Databricks REST API,您必須驗證

新增成員

端點 HTTP 方法
2.0/groups/add-member POST

將使用者或群組新增至群組。 如果具有指定名稱的使用者或群組不存在,或具有指定父名稱的群組不存在,則此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST

範例

若要將使用者新增至群組:

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/add-member \
--data '{ "user_name": "someone@example.com", "parent_name": "reporting-department" }'
{}

若要將群組新增至另一個群組:

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/add-member \
--data '{ "group_name": "reporting-department", "parent_name": "data-ops-read-only" }'
{}

要求結構

欄位名稱 類型 Description
user_name OR group_name STRINGSTRING 如果user_name,則為使用者名稱。

如果group_name,組名。
parent_name STRING 將加入新成員之父群組的名稱。 此為必要欄位。

創建

端點 HTTP 方法
2.0/groups/create POST

建立具有指定名稱的新群組。 如果具有指定名稱的群組已經存在,則此呼叫會傳回錯誤 RESOURCE_ALREADY_EXISTS

範例

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/create \
--data '{ "group_name": "reporting-department" }'
{ "group_name": "reporting-department" }

要求結構

欄位名稱 類型 Description
group_name STRING 群組的名稱;此組織所擁有的群組之間必須是唯一的。 此為必要欄位。

回應結構

欄位名稱 類型 Description
group_name STRING 群組名稱。

列出成員

端點 HTTP 方法
2.0/groups/list-members GET

傳回特定群組的所有成員。 如果具有指定名稱的群組不存在,則此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST 。 這個方法是非遞迴的;它會傳回屬於指定群組的所有群組,但不會傳回屬於這些子群組的主體。

範例

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-members \
--data '{ "group_name": "reporting-department" }' \
| jq .
{
  "members": [
    {
      "user_name": "someone@example.com"
    }
  ]
}

要求結構

欄位名稱 類型 Description
group_name STRING 我們想要擷取其成員的群組。 此為必要欄位。

回應結構

欄位名稱 類型 Description
members PrincipalName的陣列 屬於指定群組的使用者和群組。

清單

端點 HTTP 方法
2.0/groups/list GET

傳回組織中的所有群組。

範例

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list \
| jq .
{
  "group_names": [
    "reporting-department",
    "data-ops-read-only",
    "admins"
  ]
}

回應結構

欄位名稱 類型 Description
group_names STRING 的陣列。 此組織中的群組。

列出父系

端點 HTTP 方法
2.0/groups/list-parents GET

擷取指定使用者或群組是成員的所有群組。 這個方法是非遞迴的;它會傳回指定使用者或群組是成員的所有群組,但不會傳回這些群組所屬群組的所有群組。 如果具有指定名稱的使用者或群組不存在,則此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST

範例

若要列出使用者的群組:

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-parents \
--data '{ "user_name": "someone@example.com" }' \
| jq .
{
  "group_names": [
    "reporting-department"
  ]
}

若要列出群組的父群組:

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-parents \
--data '{ "group_name": "reporting-department" }' \
| jq .
{
  "group_names": [
    "data-ops-read-only"
  ]
}

要求結構

欄位名稱 類型 Description
user_name OR group_name STRINGSTRING 如果user_name,則為使用者名稱。

如果group_name,組名。

回應結構

欄位名稱 類型 Description
group_names STRING 的陣列。 指定使用者或群組所屬的群組。

移除成員

端點 HTTP 方法
2.0/groups/remove-member POST

從群組中移除使用者或群組。 如果具有指定名稱的使用者或群組不存在,或具有指定父名稱的群組不存在,則此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST

範例

若要從群組中移除使用者:

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/remove-member \
--data '{ "user_name": "someone@example.com", "parent_name": "reporting-department" }'
{}

若要從另一個群組移除群組:

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/remove-member \
--data '{ "group_name": "reporting-department", "parent_name": "data-ops-read-only" }'
{}

要求結構

欄位名稱 類型 Description
user_name OR group_name STRINGSTRING 如果user_name,則為使用者名稱。

如果group_name,組名。
parent_name STRING 要從中移除成員的父群組名稱。 此為必要欄位。

刪除

端點 HTTP 方法
2.0/groups/delete POST

從此組織移除群組。 如果具有指定名稱的群組不存在,則此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST

範例

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/delete \
--data '{ "group_name": "reporting-department" }'
{}

要求結構

欄位名稱 類型 Description
group_name STRING 要移除的群組。 此為必要欄位。

資料結構

本節內容:

PrincipalName

使用者名稱或組名的容器類型。

欄位名稱 類型 Description
user_name OR group_name STRINGSTRING 如果user_name,則為使用者名稱。

如果group_name,組名。