semantic-link-labs 0.8.2__py3-none-any.whl → 0.8.4__py3-none-any.whl

sempy_labs/_vertipaq.py

@@ -13,7 +13,7 @@ from sempy_labs._helper_functions import (
     resolve_dataset_id,
     save_as_delta_table,
     resolve_workspace_capacity,
-    get_max_run_id,
+    _get_max_run_id,
 )
 from sempy_labs._list_functions import list_relationships, list_tables
 from sempy_labs.lakehouse import lakehouse_attached, get_lakehouse_tables
@@ -69,73 +69,67 @@ def vertipaq_analyzer(
 
     workspace = fabric.resolve_workspace_name(workspace)
 
-    data_type_string = "string"
-    data_type_long = "long"
-    data_type_timestamp = "timestamp"
-    data_type_double = "double"
-    data_type_bool = "bool"
-
     vertipaq_map = {
         "Model": {
-            "Dataset Name": data_type_string,
-            "Total Size": data_type_long,
-            "Table Count": data_type_long,
-            "Column Count": data_type_long,
-            "Compatibility Level": data_type_long,
-            "Default Mode": data_type_string,
+            "Dataset Name": [icons.data_type_string, icons.no_format],
+            "Total Size": [icons.data_type_long, icons.int_format],
+            "Table Count": [icons.data_type_long, icons.int_format],
+            "Column Count": [icons.data_type_long, icons.int_format],
+            "Compatibility Level": [icons.data_type_long, icons.no_format],
+            "Default Mode": [icons.data_type_string, icons.no_format],
         },
         "Tables": {
-            "Table Name": data_type_string,
-            "Type": data_type_string,
-            "Row Count": data_type_long,
-            "Total Size": data_type_long,
-            "Dictionary Size": data_type_long,
-            "Data Size": data_type_long,
-            "Hierarchy Size": data_type_long,
-            "Relationship Size": data_type_long,
-            "User Hierarchy Size": data_type_long,
-            "Partitions": data_type_long,
-            "Columns": data_type_long,
-            "% DB": data_type_double,
+            "Table Name": [icons.data_type_string, icons.no_format],
+            "Type": [icons.data_type_string, icons.no_format],
+            "Row Count": [icons.data_type_long, icons.int_format],
+            "Total Size": [icons.data_type_long, icons.int_format],
+            "Dictionary Size": [icons.data_type_long, icons.int_format],
+            "Data Size": [icons.data_type_long, icons.int_format],
+            "Hierarchy Size": [icons.data_type_long, icons.int_format],
+            "Relationship Size": [icons.data_type_long, icons.int_format],
+            "User Hierarchy Size": [icons.data_type_long, icons.int_format],
+            "Partitions": [icons.data_type_long, icons.int_format],
+            "Columns": [icons.data_type_long, icons.int_format],
+            "% DB": [icons.data_type_double, icons.pct_format],
         },
         "Partitions": {
-            "Table Name": data_type_string,
-            "Partition Name": data_type_string,
-            "Mode": data_type_string,
-            "Record Count": data_type_long,
-            "Segment Count": data_type_long,
-            "Records per Segment": data_type_double,
+            "Table Name": [icons.data_type_string, icons.no_format],
+            "Partition Name": [icons.data_type_string, icons.no_format],
+            "Mode": [icons.data_type_string, icons.no_format],
+            "Record Count": [icons.data_type_long, icons.int_format],
+            "Segment Count": [icons.data_type_long, icons.int_format],
+            "Records per Segment": [icons.data_type_double, icons.int_format],
         },
         "Columns": {
-            "Table Name": data_type_string,
-            "Column Name": data_type_string,
-            "Type": data_type_string,
-            "Cardinality": data_type_long,
-            "Total Size": data_type_long,
-            "Data Size": data_type_long,
-            "Dictionary Size": data_type_long,
-            "Hierarchy Size": data_type_long,
-            "% Table": data_type_double,
-            "% DB": data_type_double,
-            "Data Type": data_type_string,
-            "Encoding": data_type_string,
-            "Is Resident": data_type_bool,
-            "Temperature": data_type_double,
-            "Last Accessed": data_type_timestamp,
+            "Table Name": [icons.data_type_string, icons.no_format],
+            "Column Name": [icons.data_type_string, icons.no_format],
+            "Type": [icons.data_type_string, icons.no_format],
+            "Cardinality": [icons.data_type_long, icons.int_format],
+            "Total Size": [icons.data_type_long, icons.int_format],
+            "Data Size": [icons.data_type_long, icons.int_format],
+            "Dictionary Size": [icons.data_type_long, icons.int_format],
+            "Hierarchy Size": [icons.data_type_long, icons.int_format],
+            "% Table": [icons.data_type_double, icons.pct_format],
+            "% DB": [icons.data_type_double, icons.pct_format],
+            "Data Type": [icons.data_type_string, icons.no_format],
+            "Encoding": [icons.data_type_string, icons.no_format],
+            "Is Resident": [icons.data_type_bool, icons.no_format],
+            "Temperature": [icons.data_type_double, icons.int_format],
+            "Last Accessed": [icons.data_type_timestamp, icons.no_format],
         },
         "Hierarchies": {
-            "Table Name": data_type_string,
-            "Hierarchy Name": data_type_string,
-            "Used Size": data_type_long,
+            "Table Name": [icons.data_type_string, icons.no_format],
+            "Hierarchy Name": [icons.data_type_string, icons.no_format],
+            "Used Size": [icons.data_type_long, icons.int_format],
         },
         "Relationships": {
-            "From Object": data_type_string,
-            "To Object": data_type_string,
-            "Multiplicity": data_type_string,
-            "Used Size": data_type_long,
-            "Max From Cardinality": data_type_long,
-            "Max To Cardinality": data_type_long,
-            "Missing Rows": data_type_long,
+            "From Object": [icons.data_type_string, icons.no_format],
+            "To Object": [icons.data_type_string, icons.no_format],
+            "Multiplicity": [icons.data_type_string, icons.no_format],
+            "Used Size": [icons.data_type_long, icons.int_format],
+            "Max From Cardinality": [icons.data_type_long, icons.int_format],
+            "Max To Cardinality": [icons.data_type_long, icons.int_format],
+            "Missing Rows": [icons.data_type_long, icons.int_format],
         },
     }
 
@@ -163,7 +157,8 @@ def vertipaq_analyzer(
         table_count = tom.model.Tables.Count
         column_count = len(list(tom.all_columns()))
 
-    dfR["Missing Rows"] = None
+    dfR["Missing Rows"] = 0
+    dfR["Missing Rows"] = dfR["Missing Rows"].astype(int)
 
     # Direct Lake
     if read_stats_from_data:
@@ -323,38 +318,16 @@ def vertipaq_analyzer(
     dfC["% DB"] = round((dfC["Total Size"] / db_total_size) * 100, 2)
     columnList = list(vertipaq_map["Columns"].keys())
 
+    dfC = dfC[dfC["Type"] != "RowNumber"].reset_index(drop=True)
+
     colSize = dfC[columnList].sort_values(by="Total Size", ascending=False)
     temp = dfC[columnList].sort_values(by="Temperature", ascending=False)
     colSize.reset_index(drop=True, inplace=True)
     temp.reset_index(drop=True, inplace=True)
 
     export_Col = colSize.copy()
-
-    int_cols = []
-    pct_cols = []
-    for k, v in vertipaq_map["Columns"].items():
-        if v in ["int", "long"]:
-            int_cols.append(k)
-        elif v in ["float", "double"] and k != "Temperature":
-            pct_cols.append(k)
-    colSize[int_cols] = colSize[int_cols].map("{:,}".format)
-    temp[int_cols] = temp[int_cols].map("{:,}".format)
-    colSize[pct_cols] = colSize[pct_cols].map("{:.2f}%".format)
-    temp[pct_cols] = temp[pct_cols].map("{:.2f}%".format)
-
-    # Tables
-    int_cols = []
-    pct_cols = []
-    for k, v in vertipaq_map["Tables"].items():
-        if v in ["int", "long"]:
-            int_cols.append(k)
-        elif v in ["float", "double"]:
-            pct_cols.append(k)
     export_Table = dfT.copy()
 
-    dfT[int_cols] = dfT[int_cols].map("{:,}".format)
-    dfT[pct_cols] = dfT[pct_cols].map("{:.2f}%".format)
-
     #  Relationships
     dfR = pd.merge(
         dfR,
@@ -386,14 +359,6 @@ def vertipaq_analyzer(
     dfR.reset_index(drop=True, inplace=True)
     export_Rel = dfR.copy()
 
-    int_cols = []
-    for k, v in vertipaq_map["Relationships"].items():
-        if v in ["int", "long"]:
-            int_cols.append(k)
-    if not read_stats_from_data:
-        int_cols.remove("Missing Rows")
-    dfR[int_cols] = dfR[int_cols].map("{:,}".format)
-
     # Partitions
     dfP = dfP[
         [
@@ -410,12 +375,6 @@ def vertipaq_analyzer(
     )  # Remove after records per segment is fixed
     dfP.reset_index(drop=True, inplace=True)
     export_Part = dfP.copy()
-    int_cols = []
-    for k, v in vertipaq_map["Partitions"].items():
-        if v in ["int", "long", "double", "float"]:
-            int_cols.append(k)
-    intList = ["Record Count", "Segment Count", "Records per Segment"]
-    dfP[intList] = dfP[intList].map("{:,}".format)
 
     # Hierarchies
     dfH_filt = dfH[dfH["Level Ordinal"] == 0]
@@ -426,8 +385,6 @@ def vertipaq_analyzer(
     dfH_filt.fillna({"Used Size": 0}, inplace=True)
     dfH_filt["Used Size"] = dfH_filt["Used Size"].astype(int)
     export_Hier = dfH_filt.copy()
-    intList = ["Used Size"]
-    dfH_filt[intList] = dfH_filt[intList].map("{:,}".format)
 
     # Model
     # Converting to KB/MB/GB necessitates division by 1024 * 1000.
@@ -453,11 +410,63 @@ def vertipaq_analyzer(
     dfModel.reset_index(drop=True, inplace=True)
     dfModel["Default Mode"] = dfModel["Default Mode"].astype(str)
     export_Model = dfModel.copy()
-    int_cols = []
-    for k, v in vertipaq_map["Model"].items():
-        if v in ["long", "int"] and k != "Compatibility Level":
-            int_cols.append(k)
-    dfModel[int_cols] = dfModel[int_cols].map("{:,}".format)
+
+    def _style_columns_based_on_types(dataframe: pd.DataFrame, column_type_mapping):
+
+        format_mapping = {
+            "int": "{:,}",
+            "pct": "{:.2f}%",
+            "": "{}",
+        }
+
+        format_dict = {
+            col: format_mapping[dt] for col, dt in column_type_mapping.items()
+        }
+
+        return dataframe.style.format(format_dict)
+
+    dfModel = _style_columns_based_on_types(
+        dfModel,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Model"].items()
+        },
+    )
+    dfT = _style_columns_based_on_types(
+        dfT,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Tables"].items()
+        },
+    )
+    dfP = _style_columns_based_on_types(
+        dfP,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Partitions"].items()
+        },
+    )
+    colSize = _style_columns_based_on_types(
+        colSize,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Columns"].items()
+        },
+    )
+    temp = _style_columns_based_on_types(
+        temp,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Columns"].items()
+        },
+    )
+    dfR = _style_columns_based_on_types(
+        dfR,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Relationships"].items()
+        },
+    )
+    dfH_filt = _style_columns_based_on_types(
+        dfH_filt,
+        column_type_mapping={
+            key: values[1] for key, values in vertipaq_map["Hierarchies"].items()
+        },
+    )
 
     dataFrames = {
         "dfModel": dfModel,
@@ -484,8 +493,6 @@ def vertipaq_analyzer(
             )
 
     if export == "table":
-        # spark = SparkSession.builder.getOrCreate()
-
         lakehouse_id = fabric.get_lakehouse_id()
         lake_workspace = fabric.resolve_workspace_name()
         lakehouse = resolve_lakehouse_name(
@@ -499,7 +506,7 @@ def vertipaq_analyzer(
         if len(lakeT_filt) == 0:
             runId = 1
         else:
-            max_run_id = get_max_run_id(lakehouse=lakehouse, table_name=lakeTName)
+            max_run_id = _get_max_run_id(lakehouse=lakehouse, table_name=lakeTName)
             runId = max_run_id + 1
 
         dfMap = {
@@ -549,23 +556,23 @@ def vertipaq_analyzer(
             df.columns = df.columns.str.replace(" ", "_")
 
             schema = {
-                "Capacity_Name": data_type_string,
-                "Capacity_Id": data_type_string,
-                "Workspace_Name": data_type_string,
-                "Workspace_Id": data_type_string,
-                "Dataset_Name": data_type_string,
-                "Dataset_Id": data_type_string,
-                "Configured_By": data_type_string,
+                "Capacity_Name": icons.data_type_string,
+                "Capacity_Id": icons.data_type_string,
+                "Workspace_Name": icons.data_type_string,
+                "Workspace_Id": icons.data_type_string,
+                "Dataset_Name": icons.data_type_string,
+                "Dataset_Id": icons.data_type_string,
+                "Configured_By": icons.data_type_string,
             }
 
             schema.update(
                 {
-                    key.replace(" ", "_"): value
+                    key.replace(" ", "_"): value[0]
                     for key, value in vertipaq_map[key_name].items()
                 }
             )
-            schema["RunId"] = data_type_long
-            schema["Timestamp"] = data_type_timestamp
+            schema["RunId"] = icons.data_type_long
+            schema["Timestamp"] = icons.data_type_timestamp
 
             delta_table_name = f"VertipaqAnalyzer_{obj}".lower()
             save_as_delta_table(
@@ -739,7 +746,11 @@ def visualize_vertipaq(dataframes):
             "ColumnName": "Column Name",
             "Tooltip": "The name of the column",
         },
-        {"ViewName": "Column", "ColumnName": "Type", "Tooltip": "The type of column"},
+        {
+            "ViewName": "Column",
+            "ColumnName": "Type",
+            "Tooltip": "The type of column",
+        },
         {
             "ViewName": "Column",
             "ColumnName": "Cardinality",

sempy_labs/_warehouses.py

@@ -11,17 +11,24 @@ from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_warehouse(
-    warehouse: str, description: Optional[str] = None, workspace: Optional[str] = None
+    warehouse: str,
+    description: Optional[str] = None,
+    case_insensitive_collation: bool = False,
+    workspace: Optional[str] = None,
 ):
     """
     Creates a Fabric warehouse.
 
+    This is a wrapper function for the following API: `Items - Create Warehouse <https://learn.microsoft.com/rest/api/fabric/warehouse/items/create-warehouse`_.
+
     Parameters
     ----------
     warehouse: str
         Name of the warehouse.
     description : str, default=None
         A description of the warehouse.
+    case_insensitive_collation: bool, default=False
+        If True, creates the warehouse with case-insensitive collation.
     workspace : str, default=None
         The Fabric workspace name.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -34,6 +41,11 @@ def create_warehouse(
 
     if description:
         request_body["description"] = description
+    if case_insensitive_collation:
+        request_body.setdefault("creationPayload", {})
+        request_body["creationPayload"][
+            "defaultCollation"
+        ] = "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
 
     client = fabric.FabricRestClient()
     response = client.post(
@@ -51,6 +63,8 @@ def list_warehouses(workspace: Optional[str] = None) -> pd.DataFrame:
     """
     Shows the warehouses within a workspace.
 
+    This is a wrapper function for the following API: `Items - List Warehouses <https://learn.microsoft.com/rest/api/fabric/warehouse/items/list-warehouses`_.
+
     Parameters
     ----------
     workspace : str, default=None
@@ -105,6 +119,8 @@ def delete_warehouse(name: str, workspace: Optional[str] = None):
     """
     Deletes a Fabric warehouse.
 
+    This is a wrapper function for the following API: `Items - Delete Warehouse <https://learn.microsoft.com/rest/api/fabric/warehouse/items/delete-warehouse`_.
+
     Parameters
     ----------
     name: str
@@ -130,3 +146,76 @@ def delete_warehouse(name: str, workspace: Optional[str] = None):
     print(
         f"{icons.green_dot} The '{name}' warehouse within the '{workspace}' workspace has been deleted."
     )
+
+
+def get_warehouse_tables(
+    warehouse: str, workspace: Optional[str] = None
+) -> pd.DataFrame:
+    """
+    Shows a list of the tables in the Fabric warehouse. This function is based on INFORMATION_SCHEMA.TABLES.
+
+    Parameters
+    ----------
+    warehouse : str
+        Name of the Fabric warehouse.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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
+        A pandas dataframe showing a list of the tables in the Fabric warehouse.
+    """
+
+    from sempy_labs._sql import ConnectWarehouse
+
+    with ConnectWarehouse(warehouse=warehouse, workspace=workspace) as sql:
+        df = sql.query(
+            """
+        SELECT TABLE_SCHEMA AS [Schema], TABLE_NAME AS [Table Name], TABLE_TYPE AS [Table Type]
+        FROM INFORMATION_SCHEMA.TABLES
+        WHERE TABLE_TYPE = 'BASE TABLE'
+        """
+        )
+
+    return df
+
+
+def get_warehouse_columns(
+    warehouse: str, workspace: Optional[str] = None
+) -> pd.DataFrame:
+    """
+    Shows a list of the columns in each table within the Fabric warehouse. This function is based on INFORMATION_SCHEMA.COLUMNS.
+
+    Parameters
+    ----------
+    warehouse : str
+        Name of the Fabric warehouse.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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
+        A pandas dataframe showing a list of the columns in each table within the Fabric warehouse.
+    """
+
+    from sempy_labs._sql import ConnectWarehouse
+
+    with ConnectWarehouse(warehouse=warehouse, workspace=workspace) as sql:
+        df = sql.query(
+            """
+        SELECT t.TABLE_SCHEMA AS [Schema], t.TABLE_NAME AS [Table Name], c.COLUMN_NAME AS [Column Name], c.DATA_TYPE AS [Data Type], c.IS_NULLABLE AS [Is Nullable], c.CHARACTER_MAXIMUM_LENGTH AS [Character Max Length]
+        FROM INFORMATION_SCHEMA.TABLES AS t
+        LEFT JOIN INFORMATION_SCHEMA.COLUMNS AS c
+        ON t.TABLE_NAME = c.TABLE_NAME
+        AND t.TABLE_SCHEMA = c.TABLE_SCHEMA
+        WHERE t.TABLE_TYPE = 'BASE TABLE'
+        """
+        )
+
+    return df

sempy_labs/_workloads.py

@@ -0,0 +1,128 @@
+import sempy.fabric as fabric
+import pandas as pd
+from typing import Optional
+import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def list_workloads(capacity_name: str) -> pd.DataFrame:
+    """
+    Returns the current state of the specified capacity workloads.
+    If a workload is enabled, the percentage of maximum memory that the workload can consume is also returned.
+
+    This is a wrapper function for the following API: `Capacities - Get Workloads <https://learn.microsoft.com/rest/api/power-bi/capacities/get-workloads>`_.
+
+    Parameters
+    ----------
+    capacity_name : str
+        The capacity name.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the current state of the specified capacity workloads.
+    """
+
+    from sempy_labs._helper_functions import resolve_capacity_id
+
+    df = pd.DataFrame(
+        columns=["Workload Name", "State", "Max Memory Percentage Set By User"]
+    )
+
+    capacity_id = resolve_capacity_id(capacity_name=capacity_name)
+
+    client = fabric.PowerBIRestClient()
+    response = client.get(f"/v1.0/myorg/capacities/{capacity_id}/Workloads")
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    for v in response.json().get("value", []):
+        new_data = {
+            "Workload Name": v.get("name"),
+            "State": v.get("state"),
+            "Max Memory Percentage Set By User": v.get("maxMemoryPercentageSetByUser"),
+        }
+        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    int_cols = ["Max Memory Percentage Set By User"]
+    df[int_cols] = df[int_cols].astype(int)
+
+    return df
+
+
+def patch_workload(
+    capacity_name: str,
+    workload_name: str,
+    state: Optional[str] = None,
+    max_memory_percentage: Optional[int] = None,
+):
+    """
+    Changes the state of a specific workload to Enabled or Disabled.
+    When enabling a workload, specify the percentage of maximum memory that the workload can consume.
+
+    This is a wrapper function for the following API: `Capacities - Patch Workload <https://learn.microsoft.com/rest/api/power-bi/capacities/patch-workload>`_.
+
+    Parameters
+    ----------
+    capacity_name : str
+        The capacity name.
+    workload_name : str
+        The workload name.
+    state : str, default=None
+        The capacity workload state.
+    max_memory_percentage : int, default=None
+        The percentage of the maximum memory that a workload can consume (set by the user).
+    """
+
+    from sempy_labs._helper_functions import resolve_capacity_id
+
+    capacity_id = resolve_capacity_id(capacity_name=capacity_name)
+
+    states = ["Disabled", "Enabled", "Unsupported"]
+    state = state.capitalize()
+    if state is not None and state not in states:
+        raise ValueError(
+            f"{icons.red_dot} Invalid 'state' parameter. Please choose from these options: {states}."
+        )
+    if max_memory_percentage is not None and (
+        max_memory_percentage < 0 or max_memory_percentage > 100
+    ):
+        raise ValueError(
+            f"{icons.red_dot} Invalid max memory percentage. Must be a value between 0-100."
+        )
+
+    client = fabric.PowerBIRestClient()
+    url = f"/v1.0/myorg/capacities/{capacity_id}/Workloads/{workload_name}"
+    get_response = client.get(url)
+    if get_response.status_code != 200:
+        raise FabricHTTPException(get_response)
+
+    get_json = get_response.json().get("value")
+    current_state = get_json.get("state")
+    current_max_memory = get_json.get("maxMemoryPercentageSetByUser")
+
+    if current_state == state and str(current_max_memory) == str(max_memory_percentage):
+        print(
+            f"{icons.info} The current workload settings are the same as those specified in the parameters of this function. The workload has not been updated."
+        )
+        return
+
+    payload = {}
+    if state is not None:
+        payload["state"] = state
+    else:
+        payload["state"] = current_state
+    if max_memory_percentage is not None:
+        payload["maxMemoryPercentageSetByUser"] = max_memory_percentage
+    else:
+        payload["maxMemoryPercentageSetByUser"] = current_max_memory
+
+    response = client.patch(url, json=payload)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    print(
+        f"The '{workload_name}' workload within the '{capacity_name}' capacity has been updated accordingly."
+    )

sempy_labs/_workspace_identity.py

@@ -12,6 +12,8 @@ def provision_workspace_identity(workspace: Optional[str] = None):
     """
     Provisions a workspace identity for a workspace.
 
+    This is a wrapper function for the following API: `Workspaces - Provision Identity <https://learn.microsoft.com/rest/api/fabric/core/workspaces/provision-identity`_.
+
     Parameters
     ----------
     workspace : str, default=None
@@ -20,8 +22,6 @@ def provision_workspace_identity(workspace: Optional[str] = None):
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    # https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/provision-identity?tabs=HTTP
-
     workspace, workspace_id = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
@@ -41,6 +41,8 @@ def deprovision_workspace_identity(workspace: Optional[str] = None):
     """
     Deprovisions a workspace identity for a workspace.
 
+    This is a wrapper function for the following API: `Workspaces - Derovision Identity <https://learn.microsoft.com/rest/api/fabric/core/workspaces/deprovision-identity`_.
+
     Parameters
     ----------
     workspace : str, default=None
@@ -49,8 +51,6 @@ def deprovision_workspace_identity(workspace: Optional[str] = None):
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    # https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/deprovision-identity?tabs=HTTP
-
     workspace, workspace_id = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()