إدارة أذونات لوحة المعلومات باستخدام واجهة برمجة تطبيقات مساحة العمل

يوضح هذا البرنامج التعليمي كيفية إدارة أذونات لوحة المعلومات باستخدام واجهة برمجة تطبيقات مساحة العمل. تتضمن كل خطوة نموذج طلب واستجابة وتفسيرات حول كيفية استخدام أدوات واجهة برمجة التطبيقات والخصائص معا.

المتطلبات الأساسية

• تحتاج إلى رمز وصول شخصي للاتصال بمساحة العمل الخاصة بك. راجع مصادقة الرمز المميز للوصول الشخصي ل Azure Databricks.
• تحتاج إلى معرف مساحة العمل لمساحة العمل التي تريد الوصول إليها. راجع أسماء مثيلات مساحة العمل وعناوين URL ومعرفاتها
• الإلمام بمرجع Databricks REST API.

معلمات المسار

يتطلب كل طلب نقطة نهاية في هذه المقالة معلمتين مسار، workspace_object_type و workspace_object_id.

• workspace_object_type: بالنسبة للوحات معلومات الذكاء الاصطناعي/BI، يكون نوع الكائن هو dashboards.
• workspace_object_id: يتوافق هذا مع resource_id المقترن بلوحة المعلومات. يمكنك استخدام GET /api/2.0/workspace/list أو GET /api/2.0/workspace/get-status لاسترداد تلك القيمة. وهي سلسلة مكونة من 32 حرفا مشابهة ل 01eec14769f616949d7a44244a53ed10.

راجع الخطوة 1: استكشاف دليل مساحة عمل للحصول على مثال لسرد كائنات مساحة العمل. راجع 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/"
                ]
        }
]
}
]
}

تعيين أذونات كائن مساحة العمل

يمكنك تعيين أذونات على لوحات المعلومات باستخدام نقطة نهاية تعيين أذونات كائن مساحة العمل. راجع 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"
}
]
}

بالنسبة للوحات معلومات الذكاء الاصطناعي/BI، يمكنك استخدام المجموعة All account users لتعيين إذن العرض لجميع المستخدمين المسجلين في حساب Azure Databricks. راجع مشاركة لوحة معلومات منشورة.

تحديث أذونات كائن مساحة العمل

تؤدي نقطة نهاية تحديث أذونات كائن مساحة العمل وظائف مشابهة لنقطة نهاية تعيين أذونات كائن مساحة العمل. يقوم بتعيين أذونات باستخدام 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"
    }
  ]
}