Управление разрешениями панели мониторинга с помощью API рабочей области

Статья
07/18/2024

В этом руководстве показано, как управлять разрешениями панели мониторинга с помощью API рабочей области. Каждый шаг включает пример запроса и ответа и объяснения о том, как использовать инструменты и свойства API вместе.

Необходимые компоненты

Для подключения к рабочей области требуется личный маркер доступа. См . проверку подлинности маркера личного доступа Azure Databricks.
Вам нужен идентификатор рабочей области рабочей области, к которой вы хотите получить доступ. См. имена экземпляров рабочей области, URL-адреса и идентификаторы
Знакомство со справочником по REST API Databricks.

Параметры пути

Для каждого запроса конечной точки в этой статье требуются два параметра пути и workspace_object_type workspace_object_id.

workspace_object_type: для панелей мониторинга AI/BI тип объекта имеет тип dashboards.
workspace_object_id: это соответствует связанной resource_id с панели мониторинга. Для получения этого значения можно использовать GET /api/2.0/workspace/list или GET /api/2.0/workspace/get-status . Это 32-символьная строка, аналогичная 01eec14769f616949d7a44244a53ed10.

См. шаг 1. Изучение каталога рабочей области для примера перечисления объектов рабочей области. Дополнительные сведения об API списка рабочих областей см. в разделе GET /api/2.0/workspace/list .

Получение уровней разрешений объекта рабочей области

В этом разделе используется конечная точка уровня разрешений объекта рабочей области для получения уровней разрешений, которые пользователь может иметь на панели мониторинга. См. раздел GET /api/workspace/workspace/getpermissionlevels.

В следующем примере запрос содержит примеры параметров пути, описанных выше. Ответ включает разрешения, которые можно применить к панели мониторинга, указанной в запросе.

GET /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10/permissionLevels

Response:
{
        "permission_levels": [
                {
                        "permission_level": "CAN_READ",
                        "description": "Can view the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_RUN",
                        "description": "Can view, attach/detach, and run the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_EDIT",
                        "description": "Can view, attach/detach, run, and edit the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_MANAGE",
                        "description": "Can view, attach/detach, run, edit, and change permissions of the Lakeview dashboard"
                }
        ]
}

Получение сведений о разрешениях объекта рабочей области

Конечная точка разрешений объекта рабочей области получает назначенные разрешения для определенного объекта рабочей области. См. статью GET /api/workspace/workspace/getpermissions.

В следующем примере показан запрос и ответ на панель мониторинга в предыдущем примере. Ответ содержит сведения о панели мониторинга и пользователях и группах с разрешениями на панели мониторинга. Разрешения для этого объекта наследуются для обоих элементов в access_control_list части ответа. В первой записи разрешения наследуются из папки в рабочей области. Вторая запись показывает разрешения, унаследованные членством в группе. admins


GET /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Response:
{
"object_id": "/dashboards/490384175243923",
"object_type": "dashboard",
"access_control_list": [
  {
  "user_name": "first.last@example.com",
  "display_name": "First Last",
  "all_permissions": [
        {
          "permission_level": "CAN_MANAGE",
          "inherited": true,
          "inherited_from_object": [
                        "/directories/2951435987702195"
                ]
        }
]
},
{
"group_name": "admins",
"all_permissions": [
        {
                "permission_level": "CAN_MANAGE",
                "inherited": true,
                "inherited_from_object": [
                        "/directories/"
                ]
        }
]
}
]
}

Настройка разрешений объекта рабочей области

Вы можете задать разрешения на панелях мониторинга с помощью конечной точки разрешений объекта рабочей области Set. См. статью PUT /api/workspace/workspace/setpermissions.

В следующем примере предоставляется разрешение CAN EDIT для всех пользователей рабочей области для workspace_object_id запроса PUT.

PUT /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Request body:

{
"access_control_list": [
{
        "group_name": "users",
        "permission_level": "CAN_EDIT"
}
]
}

Для панелей мониторинга AI/BI можно использовать группу All account users , чтобы назначить разрешение на просмотр всем пользователям, зарегистрированным в учетной записи Azure Databricks. См . раздел "Общий доступ к опубликованной панели мониторинга".

Обновление разрешений объекта рабочей области

Конечная точка разрешений объекта рабочей области Update выполняет функции, аналогичные конечной точке разрешений объекта рабочей области Set. Он назначает разрешения с помощью PATCH запроса вместо PUT запроса.

См. статью PATCH /api/workspace/workspace/updatepermissions.


PATCH /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Request body:

{
  "access_control_list": [
    {
      "group_name": "account userS",
      "permission_level": "CAN_VIEW"
    }
  ]
}

Поделиться через