semantic-link-labs 0.12.4__py3-none-any.whl → 0.12.5__py3-none-any.whl

sempy_labs/_onelake.py

@@ -0,0 +1,131 @@
+from sempy_labs._helper_functions import (
+    _base_api,
+    resolve_workspace_id,
+    resolve_lakehouse_name_and_id,
+    resolve_workspace_name_and_id,
+)
+from sempy._utils._log import log
+from uuid import UUID
+from typing import Optional
+import pandas as pd
+import sempy_labs._icons as icons
+
+
+@log
+def get_onelake_settings(workspace: Optional[str | UUID] = None):
+    """
+    Obtains the workspace OneLake settings.
+
+    This is a wrapper function for the following API: `OneLake Settings - Get Settings <https://learn.microsoft.com/rest/api/fabric/core/onelake-settings/get-settings>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        The workspace OneLake settings.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/onelake/settings", client="fabric_sp"
+    ).json()
+
+    d = result.get("diagnostics", {})
+    enabled = True if d.get("status", {}) == "Enabled" else False
+    rows = []
+    rows.append(
+        {
+            "Enabled": enabled,
+            "Destination Type": (
+                d.get("destination", {}).get("type", {}) if enabled else None
+            ),
+            "Destination Id": (
+                d.get("destination", {}).get("lakehouse", {}).get("itemId", {})
+                if enabled
+                else None
+            ),
+            "Destination Workspace Id": (
+                d.get("destination", {}).get("lakehouse", {}).get("workspaceId", {})
+                if enabled
+                else None
+            ),
+        }
+    )
+
+    return pd.DataFrame(rows)
+
+
+def modify_onelake_diagnostics(
+    workspace: Optional[str | UUID] = None,
+    enabled: bool = True,
+    destination_lakehouse: Optional[str | UUID] = None,
+    destination_workspace: Optional[str | UUID] = None,
+):
+    """
+    Obtains the workspace OneLake settings.
+
+    This is a wrapper function for the following API: `OneLake Settings - Modify Diagnostics <https://learn.microsoft.com/rest/api/fabric/core/onelake-settings/modify-diagnostics>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    enabled : bool, default=True
+        Whether to enable or disable OneLake diagnostics.
+    destination_lakehouse : str | uuid.UUID, default=None
+        The name or ID of the destination lakehouse.
+        Defaults to None which resolves to the lakehouse of the attached lakehouse
+        or if no lakehouse attached, resolves to the lakehouse of the notebook.
+    destination_workspace : str | uuid.UUID, default=None
+        The name or ID of the destination workspace.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    (destination_workspace_name, destination_workspace_id) = (
+        resolve_workspace_name_and_id(destination_workspace)
+    )
+    (destination_lakehouse_name, destination_lakehouse_id) = (
+        resolve_lakehouse_name_and_id(destination_lakehouse, destination_workspace_id)
+    )
+
+    if enabled:
+        payload = {
+            "status": "Enabled",
+            "destination": {
+                "type": "Lakehouse",
+                "lakehouse": {
+                    "referenceType": "ById",
+                    "itemId": destination_lakehouse_id,
+                    "workspaceId": destination_workspace_id,
+                },
+            },
+        }
+    else:
+        payload = {"status": "Disabled"}
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/onelake/settings/modifyDiagnostics",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+    )
+
+    if enabled:
+        print(
+            f"{icons.green_dot} OneLake diagnostics have been enabled and updated to use the '{destination_lakehouse_name}' lakehouse in the '{destination_workspace_name}' workspace as the destination."
+        )
+    else:
+        print(f"{icons.green_dot} OneLake diagnostics have been disabled.")

sempy_labs/admin/_basic_functions.py

@@ -1,10 +1,9 @@
 from typing import Optional, List, Union, Tuple
 from uuid import UUID
 import sempy_labs._icons as icons
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
     _build_url,
-    _update_dataframe_datatypes,
     _base_api,
     _create_dataframe,
 )
@@ -337,16 +336,23 @@ def list_workspace_access_details(
         request=f"/v1/admin/workspaces/{workspace_id}/users", client="fabric_sp"
     )
 
+    rows = []
     for v in response.json().get("accessDetails", []):
-        new_data = {
-            "User Id": v.get("principal", {}).get("id"),
-            "User Name": v.get("principal", {}).get("displayName"),
-            "User Type": v.get("principal", {}).get("type"),
-            "Workspace Name": workspace_name,
-            "Workspace Id": workspace_id,
-            "Workspace Role": v.get("workspaceAccessDetails", {}).get("workspaceRole"),
-        }
-        df = pd.concat([df, pd.DataFrame([new_data])], ignore_index=True)
+        rows.append(
+            {
+                "User Id": v.get("principal", {}).get("id"),
+                "User Name": v.get("principal", {}).get("displayName"),
+                "User Type": v.get("principal", {}).get("type"),
+                "Workspace Name": workspace_name,
+                "Workspace Id": workspace_id,
+                "Workspace Role": v.get("workspaceAccessDetails", {}).get(
+                    "workspaceRole"
+                ),
+            }
+        )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 
@@ -454,6 +460,4 @@ def list_workspace_users(workspace: Optional[str | UUID] = None) -> pd.DataFrame
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))
 
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
-
     return df

sempy_labs/admin/_workspaces.py

@@ -1,4 +1,4 @@
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     _base_api,
     _build_url,
     _encode_user,
@@ -8,7 +8,7 @@ from .._helper_functions import (
 
 from uuid import UUID
 from typing import Optional
-from ._basic_functions import (
+from sempy_labs.admin._basic_functions import (
     _resolve_workspace_name_and_id,
 )
 import sempy_labs._icons as icons

sempy_labs/deployment_pipeline/__init__.py

@@ -0,0 +1,21 @@
+from ._items import (
+    list_deployment_pipeline_operations,
+    list_deployment_pipeline_role_assignments,
+    list_deployment_pipeline_stage_items,
+    list_deployment_pipeline_stages,
+    list_deployment_pipelines,
+    unassign_workspace_from_stage,
+    assign_workspace_to_stage,
+    delete_deployment_pipeline,
+)
+
+__all__ = [
+    "list_deployment_pipeline_operations",
+    "list_deployment_pipeline_role_assignments",
+    "list_deployment_pipeline_stage_items",
+    "list_deployment_pipeline_stages",
+    "list_deployment_pipelines",
+    "unassign_workspace_from_stage",
+    "assign_workspace_to_stage",
+    "delete_deployment_pipeline",
+]