semantic-link-labs 0.7.2__py3-none-any.whl → 0.7.4__py3-none-any.whl

sempy_labs/_list_functions.py

@@ -1,19 +1,15 @@
 import sempy.fabric as fabric
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    resolve_lakehouse_name,
     create_relationship_name,
     resolve_lakehouse_id,
     resolve_dataset_id,
-    _decode_b64,
     pagination,
     lro,
     resolve_item_type,
+    format_dax_object_name,
 )
 import pandas as pd
-import base64
-import requests
-from pyspark.sql import SparkSession
 from typing import Optional
 import sempy_labs._icons as icons
 from sempy.fabric.exceptions import FabricHTTPException
@@ -86,7 +82,9 @@ def get_object_level_security(
         return df
 
 
-def list_tables(dataset: str, workspace: Optional[str] = None) -> pd.DataFrame:
+def list_tables(
+    dataset: str, workspace: Optional[str] = None, extended: Optional[bool] = False
+) -> pd.DataFrame:
     """
     Shows a semantic model's tables and their properties.
 
@@ -98,6 +96,8 @@ def list_tables(dataset: str, workspace: Optional[str] = None) -> pd.DataFrame:
         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.
+    extended : bool, default=False
+        Adds additional columns including Vertipaq statistics.
 
     Returns
     -------
@@ -105,18 +105,152 @@ def list_tables(dataset: str, workspace: Optional[str] = None) -> pd.DataFrame:
         A pandas dataframe showing the semantic model's tables and their properties.
     """
 
+    from sempy_labs.tom import connect_semantic_model
+
     workspace = fabric.resolve_workspace_name(workspace)
 
-    df = fabric.list_tables(
-        dataset=dataset,
-        workspace=workspace,
-        additional_xmla_properties=["RefreshPolicy", "RefreshPolicy.SourceExpression"],
+    df = pd.DataFrame(
+        columns=[
+            "Name",
+            "Description",
+            "Hidden",
+            "Data Category",
+            "Type",
+            "Refresh Policy",
+            "Source Expression",
+        ]
     )
 
-    df["Refresh Policy"] = df["Refresh Policy"].notna()
-    df.rename(
-        columns={"Refresh Policy Source Expression": "Source Expression"}, inplace=True
-    )
+    with connect_semantic_model(
+        dataset=dataset, workspace=workspace, readonly=True
+    ) as tom:
+        if extended:
+            dict_df = fabric.evaluate_dax(
+                dataset=dataset,
+                workspace=workspace,
+                dax_string="""
+                EVALUATE SELECTCOLUMNS(FILTER(INFO.STORAGETABLECOLUMNS(), [COLUMN_TYPE] = "BASIC_DATA"),[DIMENSION_NAME],[DICTIONARY_SIZE])
+                """,
+            )
+            dict_sum = dict_df.groupby("[DIMENSION_NAME]")["[DICTIONARY_SIZE]"].sum()
+            data = fabric.evaluate_dax(
+                dataset=dataset,
+                workspace=workspace,
+                dax_string="""EVALUATE SELECTCOLUMNS(INFO.STORAGETABLECOLUMNSEGMENTS(),[TABLE_ID],[DIMENSION_NAME],[USED_SIZE])""",
+            )
+            data_sum = (
+                data[
+                    ~data["[TABLE_ID]"].str.startswith("R$")
+                    & ~data["[TABLE_ID]"].str.startswith("U$")
+                    & ~data["[TABLE_ID]"].str.startswith("H$")
+                ]
+                .groupby("[DIMENSION_NAME]")["[USED_SIZE]"]
+                .sum()
+            )
+            hier_sum = (
+                data[data["[TABLE_ID]"].str.startswith("H$")]
+                .groupby("[DIMENSION_NAME]")["[USED_SIZE]"]
+                .sum()
+            )
+            rel_sum = (
+                data[data["[TABLE_ID]"].str.startswith("R$")]
+                .groupby("[DIMENSION_NAME]")["[USED_SIZE]"]
+                .sum()
+            )
+            uh_sum = (
+                data[data["[TABLE_ID]"].str.startswith("U$")]
+                .groupby("[DIMENSION_NAME]")["[USED_SIZE]"]
+                .sum()
+            )
+            rc = fabric.evaluate_dax(
+                dataset=dataset,
+                workspace=workspace,
+                dax_string="""
+                SELECT [DIMENSION_NAME],[ROWS_COUNT] FROM $SYSTEM.DISCOVER_STORAGE_TABLES
+                WHERE RIGHT ( LEFT ( TABLE_ID, 2 ), 1 ) <> '$'
+            """,
+            )
+
+            model_size = (
+                dict_sum.sum()
+                + data_sum.sum()
+                + hier_sum.sum()
+                + rel_sum.sum()
+                + uh_sum.sum()
+            )
+
+        rows = []
+        for t in tom.model.Tables:
+            t_name = t.Name
+            t_type = (
+                "Calculation Group"
+                if t.CalculationGroup
+                else (
+                    "Calculated Table"
+                    if tom.is_calculated_table(table_name=t.Name)
+                    else "Table"
+                )
+            )
+            ref = bool(t.RefreshPolicy)
+            ref_se = t.RefreshPolicy.SourceExpression if ref else None
+
+            new_data = {
+                "Name": t_name,
+                "Description": t.Description,
+                "Hidden": t.IsHidden,
+                "Data Category": t.DataCategory,
+                "Type": t_type,
+                "Refresh Policy": ref,
+                "Source Expression": ref_se,
+            }
+
+            if extended:
+                dict_size = dict_sum.get(t_name, 0)
+                data_size = data_sum.get(t_name, 0)
+                h_size = hier_sum.get(t_name, 0)
+                r_size = rel_sum.get(t_name, 0)
+                u_size = uh_sum.get(t_name, 0)
+                total_size = data_size + dict_size + h_size + r_size + u_size
+
+                new_data.update(
+                    {
+                        "Row Count": (
+                            rc[rc["DIMENSION_NAME"] == t_name]["ROWS_COUNT"].iloc[0]
+                            if not rc.empty
+                            else 0
+                        ),
+                        "Total Size": total_size,
+                        "Dictionary Size": dict_size,
+                        "Data Size": data_size,
+                        "Hierarchy Size": h_size,
+                        "Relationship Size": r_size,
+                        "User Hierarchy Size": u_size,
+                        "Partitions": int(len(t.Partitions)),
+                        "Columns": sum(
+                            1 for c in t.Columns if str(c.Type) != "RowNumber"
+                        ),
+                        "% DB": round((total_size / model_size) * 100, 2),
+                    }
+                )
+
+            rows.append(new_data)
+
+        df = pd.DataFrame(rows)
+
+        if extended:
+            int_cols = [
+                "Row Count",
+                "Total Size",
+                "Dictionary Size",
+                "Data Size",
+                "Hierarchy Size",
+                "Relationship Size",
+                "User Hierarchy Size",
+                "Partitions",
+                "Columns",
+            ]
+            df[int_cols] = df[int_cols].astype(int)
+            df["% DB"] = df["% DB"].astype(float)
 
     return df
 
@@ -384,6 +518,7 @@ def list_columns(
     from sempy_labs.directlake._get_directlake_lakehouse import (
         get_direct_lake_lakehouse,
     )
+    from pyspark.sql import SparkSession
 
     workspace = fabric.resolve_workspace_name(workspace)
 
@@ -880,14 +1015,10 @@ def list_eventstreams(workspace: Optional[str] = None) -> pd.DataFrame:
 
     for r in responses:
         for v in r.get("value", []):
-            model_id = v.get("id")
-            modelName = v.get("displayName")
-            desc = v.get("description")
-
             new_data = {
-                "Eventstream Name": modelName,
-                "Eventstream ID": model_id,
-                "Description": desc,
+                "Eventstream Name": v.get("displayName"),
+                "Eventstream ID": v.get("id"),
+                "Description": v.get("description"),
             }
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
@@ -1030,10 +1161,6 @@ def create_warehouse(
         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
-    -------
-
     """
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
@@ -1045,11 +1172,11 @@ def create_warehouse(
 
     client = fabric.FabricRestClient()
     response = client.post(
-        f"/v1/workspaces/{workspace_id}/warehouses/", json=request_body, lro_wait=True
+        f"/v1/workspaces/{workspace_id}/warehouses/", json=request_body
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    lro(client, response, status_codes=[201, 202])
+
     print(
         f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace}' workspace."
     )
@@ -1161,6 +1288,8 @@ def list_relationships(
     workspace = fabric.resolve_workspace_name(workspace)
 
     dfR = fabric.list_relationships(dataset=dataset, workspace=workspace)
+    dfR["From Object"] = format_dax_object_name(dfR["From Table"], dfR["From Column"])
+    dfR["To Object"] = format_dax_object_name(dfR["To Table"], dfR["To Column"])
 
     if extended:
         # Used to map the Relationship IDs
@@ -1216,44 +1345,6 @@ def list_relationships(
     return dfR
 
 
-def list_dataflow_storage_accounts() -> pd.DataFrame:
-    """
-    Shows the accessible dataflow storage accounts.
-
-    Parameters
-    ----------
-
-    Returns
-    -------
-    pandas.DataFrame
-        A pandas dataframe showing the accessible dataflow storage accounts.
-    """
-
-    df = pd.DataFrame(
-        columns=[
-            "Dataflow Storage Account ID",
-            "Dataflow Storage Account Name",
-            "Enabled",
-        ]
-    )
-    client = fabric.PowerBIRestClient()
-    response = client.get("/v1.0/myorg/dataflowStorageAccounts")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    for v in response.json().get("value", []):
-        new_data = {
-            "Dataflow Storage Account ID": v.get("id"),
-            "Dataflow Storage Account Name": v.get("name"),
-            "Enabled": v.get("isEnabled"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    df["Enabled"] = df["Enabled"].astype(bool)
-
-    return df
-
-
 def list_kpis(dataset: str, workspace: Optional[str] = None) -> pd.DataFrame:
     """
     Shows a semantic model's KPIs and their properties.
@@ -1318,48 +1409,6 @@ def list_kpis(dataset: str, workspace: Optional[str] = None) -> pd.DataFrame:
         return df
 
 
-def list_workspace_role_assignments(workspace: Optional[str] = None) -> pd.DataFrame:
-    """
-    Shows the members of a given workspace.
-
-    Parameters
-    ----------
-    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 the members of a given workspace and their roles.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    df = pd.DataFrame(columns=["User Name", "User Email", "Role Name", "Type"])
-
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/roleAssignments")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    for r in responses:
-        for i in r.get("value", []):
-            principal = i.get("principal", {})
-            new_data = {
-                "User Name": principal.get("displayName"),
-                "Role Name": i.get("role"),
-                "Type": principal.get("type"),
-                "User Email": principal.get("userDetails", {}).get("userPrincipalName"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
-
-
 def list_semantic_model_objects(
     dataset: str, workspace: Optional[str] = None
 ) -> pd.DataFrame:
@@ -1634,933 +1683,42 @@ def list_shortcuts(
     return df
 
 
-def list_custom_pools(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_capacities() -> pd.DataFrame:
     """
-    Lists all `custom pools <https://learn.microsoft.com/fabric/data-engineering/create-custom-spark-pools>`_ within a workspace.
+    Shows the capacities and their properties.
 
     Parameters
     ----------
-    workspace : str, default=None
-        The name of the Fabric 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
-        A pandas dataframe showing all the custom pools within the Fabric workspace.
+        A pandas dataframe showing the capacities and their properties
     """
 
-    # https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/list-workspace-custom-pools
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
     df = pd.DataFrame(
-        columns=[
-            "Custom Pool ID",
-            "Custom Pool Name",
-            "Type",
-            "Node Family",
-            "Node Size",
-            "Auto Scale Enabled",
-            "Auto Scale Min Node Count",
-            "Auto Scale Max Node Count",
-            "Dynamic Executor Allocation Enabled",
-            "Dynamic Executor Allocation Min Executors",
-            "Dynamic Executor Allocation Max Executors",
-        ]
+        columns=["Id", "Display Name", "Sku", "Region", "State", "Admins"]
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/spark/pools")
+    client = fabric.PowerBIRestClient()
+    response = client.get("/v1.0/myorg/capacities")
     if response.status_code != 200:
         raise FabricHTTPException(response)
 
-    for i in response.json()["value"]:
-
-        aScale = i.get("autoScale", {})
-        d = i.get("dynamicExecutorAllocation", {})
-
+    for i in response.json().get("value", []):
         new_data = {
-            "Custom Pool ID": i.get("id"),
-            "Custom Pool Name": i.get("name"),
-            "Type": i.get("type"),
-            "Node Family": i.get("nodeFamily"),
-            "Node Size": i.get("nodeSize"),
-            "Auto Scale Enabled": aScale.get("enabled"),
-            "Auto Scale Min Node Count": aScale.get("minNodeCount"),
-            "Auto Scale Max Node Count": aScale.get("maxNodeCount"),
-            "Dynamic Executor Allocation Enabled": d.get("enabled"),
-            "Dynamic Executor Allocation Min Executors": d.get("minExecutors"),
-            "Dynamic Executor Allocation Max Executors": d.get("maxExecutors"),
+            "Id": i.get("id").lower(),
+            "Display Name": i.get("displayName"),
+            "Sku": i.get("sku"),
+            "Region": i.get("region"),
+            "State": i.get("state"),
+            "Admins": [i.get("admins", [])],
         }
         df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    bool_cols = ["Auto Scale Enabled", "Dynamic Executor Allocation Enabled"]
-    int_cols = [
-        "Auto Scale Min Node Count",
-        "Auto Scale Max Node Count",
-        "Dynamic Executor Allocation Enabled",
-        "Dynamic Executor Allocation Min Executors",
-        "Dynamic Executor Allocation Max Executors",
-    ]
-
-    df[bool_cols] = df[bool_cols].astype(bool)
-    df[int_cols] = df[int_cols].astype(int)
-
     return df
 
 
-def create_custom_pool(
-    pool_name: str,
-    node_size: str,
-    min_node_count: int,
-    max_node_count: int,
-    min_executors: int,
-    max_executors: int,
-    node_family: Optional[str] = "MemoryOptimized",
-    auto_scale_enabled: Optional[bool] = True,
-    dynamic_executor_allocation_enabled: Optional[bool] = True,
-    workspace: Optional[str] = None,
-):
-    """
-    Creates a `custom pool <https://learn.microsoft.com/fabric/data-engineering/create-custom-spark-pools>`_ within a workspace.
-
-    Parameters
-    ----------
-    pool_name : str
-        The custom pool name.
-    node_size : str
-        The `node size <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#nodesize>`_.
-    min_node_count : int
-        The `minimum node count <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-    max_node_count : int
-        The `maximum node count <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-    min_executors : int
-        The `minimum executors <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-    max_executors : int
-        The `maximum executors <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-    node_family : str, default='MemoryOptimized'
-        The `node family <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#nodefamily>`_.
-    auto_scale_enabled : bool, default=True
-        The status of `auto scale <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-    dynamic_executor_allocation_enabled : bool, default=True
-        The status of the `dynamic executor allocation <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    # https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    request_body = {
-        "name": pool_name,
-        "nodeFamily": node_family,
-        "nodeSize": node_size,
-        "autoScale": {
-            "enabled": auto_scale_enabled,
-            "minNodeCount": min_node_count,
-            "maxNodeCount": max_node_count,
-        },
-        "dynamicExecutorAllocation": {
-            "enabled": dynamic_executor_allocation_enabled,
-            "minExecutors": min_executors,
-            "maxExecutors": max_executors,
-        },
-    }
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/spark/pools", json=request_body, lro_wait=True
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{pool_name}' spark pool has been created within the '{workspace}' workspace."
-    )
-
-
-def update_custom_pool(
-    pool_name: str,
-    node_size: Optional[str] = None,
-    min_node_count: Optional[int] = None,
-    max_node_count: Optional[int] = None,
-    min_executors: Optional[int] = None,
-    max_executors: Optional[int] = None,
-    node_family: Optional[str] = None,
-    auto_scale_enabled: Optional[bool] = None,
-    dynamic_executor_allocation_enabled: Optional[bool] = None,
-    workspace: Optional[str] = None,
-):
-    """
-    Updates the properties of a `custom pool <https://learn.microsoft.com/fabric/data-engineering/create-custom-spark-pools>`_ within a workspace.
-
-    Parameters
-    ----------
-    pool_name : str
-        The custom pool name.
-    node_size : str, default=None
-        The `node size <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#nodesize>`_.
-        Defaults to None which keeps the existing property setting.
-    min_node_count : int, default=None
-        The `minimum node count <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    max_node_count : int, default=None
-        The `maximum node count <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    min_executors : int, default=None
-        The `minimum executors <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    max_executors : int, default=None
-        The `maximum executors <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    node_family : str, default=None
-        The `node family <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#nodefamily>`_.
-        Defaults to None which keeps the existing property setting.
-    auto_scale_enabled : bool, default=None
-        The status of `auto scale <https://learn.microsoft.com/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#autoscaleproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    dynamic_executor_allocation_enabled : bool, default=None
-        The status of the `dynamic executor allocation <https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/create-workspace-custom-pool?tabs=HTTP#dynamicexecutorallocationproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    # https://learn.microsoft.com/en-us/rest/api/fabric/spark/custom-pools/update-workspace-custom-pool?tabs=HTTP
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    df = list_custom_pools(workspace=workspace)
-    df_pool = df[df["Custom Pool Name"] == pool_name]
-
-    if len(df_pool) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{pool_name}' custom pool does not exist within the '{workspace}'. Please choose a valid custom pool."
-        )
-
-    if node_family is None:
-        node_family = df_pool["Node Family"].iloc[0]
-    if node_size is None:
-        node_size = df_pool["Node Size"].iloc[0]
-    if auto_scale_enabled is None:
-        auto_scale_enabled = bool(df_pool["Auto Scale Enabled"].iloc[0])
-    if min_node_count is None:
-        min_node_count = int(df_pool["Min Node Count"].iloc[0])
-    if max_node_count is None:
-        max_node_count = int(df_pool["Max Node Count"].iloc[0])
-    if dynamic_executor_allocation_enabled is None:
-        dynamic_executor_allocation_enabled = bool(
-            df_pool["Dynami Executor Allocation Enabled"].iloc[0]
-        )
-    if min_executors is None:
-        min_executors = int(df_pool["Min Executors"].iloc[0])
-    if max_executors is None:
-        max_executors = int(df_pool["Max Executors"].iloc[0])
-
-    request_body = {
-        "name": pool_name,
-        "nodeFamily": node_family,
-        "nodeSize": node_size,
-        "autoScale": {
-            "enabled": auto_scale_enabled,
-            "minNodeCount": min_node_count,
-            "maxNodeCount": max_node_count,
-        },
-        "dynamicExecutorAllocation": {
-            "enabled": dynamic_executor_allocation_enabled,
-            "minExecutors": min_executors,
-            "maxExecutors": max_executors,
-        },
-    }
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/spark/pools", json=request_body
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{pool_name}' spark pool within the '{workspace}' workspace has been updated."
-    )
-
-
-def delete_custom_pool(pool_name: str, workspace: Optional[str] = None):
-    """
-    Deletes a `custom pool <https://learn.microsoft.com/fabric/data-engineering/create-custom-spark-pools>`_ within a workspace.
-
-    Parameters
-    ----------
-    pool_name : str
-        The custom pool name.
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    dfL = list_custom_pools(workspace=workspace)
-    dfL_filt = dfL[dfL["Custom Pool Name"] == pool_name]
-
-    if len(dfL_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{pool_name}' custom pool does not exist within the '{workspace}' workspace."
-        )
-    poolId = dfL_filt["Custom Pool ID"].iloc[0]
-
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/workspaces/{workspace_id}/spark/pools/{poolId}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{pool_name}' spark pool has been deleted from the '{workspace}' workspace."
-    )
-
-
-def assign_workspace_to_capacity(capacity_name: str, workspace: Optional[str] = None):
-    """
-    Assigns a workspace to a capacity.
-
-    Parameters
-    ----------
-    capacity_name : str
-        The name of the capacity.
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    dfC = fabric.list_capacities()
-    dfC_filt = dfC[dfC["Display Name"] == capacity_name]
-    capacity_id = dfC_filt["Id"].iloc[0]
-
-    request_body = {"capacityId": capacity_id}
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/assignToCapacity",
-        json=request_body,
-        lro_wait=True,
-    )
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{workspace}' workspace has been assigned to the '{capacity_name}' capacity."
-    )
-
-
-def unassign_workspace_from_capacity(workspace: Optional[str] = None):
-    """
-    Unassigns a workspace from its assigned capacity.
-
-    Parameters
-    ----------
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    # https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/unassign-from-capacity?tabs=HTTP
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/unassignFromCapacity", lro_wait=True
-    )
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{workspace}' workspace has been unassigned from its capacity."
-    )
-
-
-def get_spark_settings(workspace: Optional[str] = None) -> pd.DataFrame:
-    """
-    Shows the spark settings for a workspace.
-
-    Parameters
-    ----------
-    workspace : str, default=None
-        The name of the Fabric 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
-        A pandas dataframe showing the spark settings for a workspace.
-    """
-
-    # https://learn.microsoft.com/en-us/rest/api/fabric/spark/workspace-settings/get-spark-settings?tabs=HTTP
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    df = pd.DataFrame(
-        columns=[
-            "Automatic Log Enabled",
-            "High Concurrency Enabled",
-            "Customize Compute Enabled",
-            "Default Pool Name",
-            "Default Pool Type",
-            "Max Node Count",
-            "Max Executors",
-            "Environment Name",
-            "Runtime Version",
-        ]
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/spark/settings")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    i = response.json()
-    p = i.get("pool")
-    dp = i.get("pool", {}).get("defaultPool", {})
-    sp = i.get("pool", {}).get("starterPool", {})
-    e = i.get("environment", {})
-
-    new_data = {
-        "Automatic Log Enabled": i.get("automaticLog").get("enabled"),
-        "High Concurrency Enabled": i.get("highConcurrency").get(
-            "notebookInteractiveRunEnabled"
-        ),
-        "Customize Compute Enabled": p.get("customizeComputeEnabled"),
-        "Default Pool Name": dp.get("name"),
-        "Default Pool Type": dp.get("type"),
-        "Max Node Count": sp.get("maxNodeCount"),
-        "Max Node Executors": sp.get("maxExecutors"),
-        "Environment Name": e.get("name"),
-        "Runtime Version": e.get("runtimeVersion"),
-    }
-    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    bool_cols = [
-        "Automatic Log Enabled",
-        "High Concurrency Enabled",
-        "Customize Compute Enabled",
-    ]
-    int_cols = ["Max Node Count", "Max Executors"]
-
-    df[bool_cols] = df[bool_cols].astype(bool)
-    df[int_cols] = df[int_cols].astype(int)
-
-    return df
-
-
-def update_spark_settings(
-    automatic_log_enabled: Optional[bool] = None,
-    high_concurrency_enabled: Optional[bool] = None,
-    customize_compute_enabled: Optional[bool] = None,
-    default_pool_name: Optional[str] = None,
-    max_node_count: Optional[int] = None,
-    max_executors: Optional[int] = None,
-    environment_name: Optional[str] = None,
-    runtime_version: Optional[str] = None,
-    workspace: Optional[str] = None,
-):
-    """
-    Updates the spark settings for a workspace.
-
-    Parameters
-    ----------
-    automatic_log_enabled : bool, default=None
-        The status of the `automatic log <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#automaticlogproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    high_concurrency_enabled : bool, default=None
-        The status of the `high concurrency <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#highconcurrencyproperties>`_ for notebook interactive run.
-        Defaults to None which keeps the existing property setting.
-    customize_compute_enabled : bool, default=None
-        `Customize compute <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#poolproperties>`_ configurations for items.
-        Defaults to None which keeps the existing property setting.
-    default_pool_name : str, default=None
-        `Default pool <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#poolproperties>`_ for workspace.
-        Defaults to None which keeps the existing property setting.
-    max_node_count : int, default=None
-        The `maximum node count <https://learn.microsoft.com/en-us/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#starterpoolproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    max_executors : int, default=None
-        The `maximum executors <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#starterpoolproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    environment_name : str, default=None
-        The name of the `default environment <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#environmentproperties>`_. Empty string indicated there is no workspace default environment
-        Defaults to None which keeps the existing property setting.
-    runtime_version : str, default=None
-        The `runtime version <https://learn.microsoft.com/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP#environmentproperties>`_.
-        Defaults to None which keeps the existing property setting.
-    workspace : str, default=None
-        The name of the Fabric 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
-    -------
-    """
-
-    # https://learn.microsoft.com/en-us/rest/api/fabric/spark/workspace-settings/update-spark-settings?tabs=HTTP
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    dfS = get_spark_settings(workspace=workspace)
-
-    if automatic_log_enabled is None:
-        automatic_log_enabled = bool(dfS["Automatic Log Enabled"].iloc[0])
-    if high_concurrency_enabled is None:
-        high_concurrency_enabled = bool(dfS["High Concurrency Enabled"].iloc[0])
-    if customize_compute_enabled is None:
-        customize_compute_enabled = bool(dfS["Customize Compute Enabled"].iloc[0])
-    if default_pool_name is None:
-        default_pool_name = dfS["Default Pool Name"].iloc[0]
-    if max_node_count is None:
-        max_node_count = int(dfS["Max Node Count"].iloc[0])
-    if max_executors is None:
-        max_executors = int(dfS["Max Executors"].iloc[0])
-    if environment_name is None:
-        environment_name = dfS["Environment Name"].iloc[0]
-    if runtime_version is None:
-        runtime_version = dfS["Runtime Version"].iloc[0]
-
-    request_body = {
-        "automaticLog": {"enabled": automatic_log_enabled},
-        "highConcurrency": {"notebookInteractiveRunEnabled": high_concurrency_enabled},
-        "pool": {
-            "customizeComputeEnabled": customize_compute_enabled,
-            "defaultPool": {"name": default_pool_name, "type": "Workspace"},
-            "starterPool": {
-                "maxNodeCount": max_node_count,
-                "maxExecutors": max_executors,
-            },
-        },
-        "environment": {"name": environment_name, "runtimeVersion": runtime_version},
-    }
-
-    client = fabric.FabricRestClient()
-    response = client.patch(
-        f"/v1/workspaces/{workspace_id}/spark/settings", json=request_body
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The spark settings within the '{workspace}' workspace have been updated accordingly."
-    )
-
-
-def add_user_to_workspace(
-    email_address: str,
-    role_name: str,
-    principal_type: Optional[str] = "User",
-    workspace: Optional[str] = None,
-):
-    """
-    Adds a user to a workspace.
-
-    Parameters
-    ----------
-    email_address : str
-        The email address of the user.
-    role_name : str
-        The `role <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#groupuseraccessright>`_ of the user within the workspace.
-    principal_type : str, default='User'
-        The `principal type <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#principaltype>`_.
-    workspace : str, default=None
-        The name 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.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    role_names = ["Admin", "Member", "Viewer", "Contributor"]
-    role_name = role_name.capitalize()
-    if role_name not in role_names:
-        raise ValueError(
-            f"{icons.red_dot} Invalid role. The 'role_name' parameter must be one of the following: {role_names}."
-        )
-    plural = "n" if role_name == "Admin" else ""
-    principal_types = ["App", "Group", "None", "User"]
-    principal_type = principal_type.capitalize()
-    if principal_type not in principal_types:
-        raise ValueError(
-            f"{icons.red_dot} Invalid princpal type. Valid options: {principal_types}."
-        )
-
-    client = fabric.PowerBIRestClient()
-
-    request_body = {
-        "emailAddress": email_address,
-        "groupUserAccessRight": role_name,
-        "principalType": principal_type,
-        "identifier": email_address,
-    }
-
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/users", json=request_body
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{email_address}' user has been added as a{plural} '{role_name}' within the '{workspace}' workspace."
-    )
-
-
-def delete_user_from_workspace(email_address: str, workspace: Optional[str] = None):
-    """
-    Removes a user from a workspace.
-
-    Parameters
-    ----------
-    email_address : str
-        The email address of the user.
-    workspace : str, default=None
-        The name 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
-    -------
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    client = fabric.PowerBIRestClient()
-    response = client.delete(f"/v1.0/myorg/groups/{workspace_id}/users/{email_address}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{email_address}' user has been removed from accessing the '{workspace}' workspace."
-    )
-
-
-def update_workspace_user(
-    email_address: str,
-    role_name: str,
-    principal_type: Optional[str] = "User",
-    workspace: Optional[str] = None,
-):
-    """
-    Updates a user's role within a workspace.
-
-    Parameters
-    ----------
-    email_address : str
-        The email address of the user.
-    role_name : str
-        The `role <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#groupuseraccessright>`_ of the user within the workspace.
-    principal_type : str, default='User'
-        The `principal type <https://learn.microsoft.com/rest/api/power-bi/groups/add-group-user#principaltype>`_.
-    workspace : str, default=None
-        The name 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.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    role_names = ["Admin", "Member", "Viewer", "Contributor"]
-    role_name = role_name.capitalize()
-    if role_name not in role_names:
-        raise ValueError(
-            f"{icons.red_dot} Invalid role. The 'role_name' parameter must be one of the following: {role_names}."
-        )
-    principal_types = ["App", "Group", "None", "User"]
-    principal_type = principal_type.capitalize()
-    if principal_type not in principal_types:
-        raise ValueError(
-            f"{icons.red_dot} Invalid princpal type. Valid options: {principal_types}."
-        )
-
-    request_body = {
-        "emailAddress": email_address,
-        "groupUserAccessRight": role_name,
-        "principalType": principal_type,
-        "identifier": email_address,
-    }
-
-    client = fabric.PowerBIRestClient()
-    response = client.put(f"/v1.0/myorg/groups/{workspace_id}/users", json=request_body)
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{email_address}' user has been updated to a '{role_name}' within the '{workspace}' workspace."
-    )
-
-
-def list_workspace_users(workspace: Optional[str] = None) -> pd.DataFrame:
-    """
-    A list of all the users of a workspace and their roles.
-
-    Parameters
-    ----------
-    workspace : str, default=None
-        The name 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
-        A pandas dataframe the users of a workspace and their properties.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    df = pd.DataFrame(columns=["User Name", "Email Address", "Role", "Type", "User ID"])
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/roleAssignments")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    for r in responses:
-        for v in r.get("value", []):
-            p = v.get("principal", {})
-            new_data = {
-                "User Name": p.get("displayName"),
-                "User ID": p.get("id"),
-                "Type": p.get("type"),
-                "Role": v.get("role"),
-                "Email Address": p.get("userDetails", {}).get("userPrincipalName"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
-
-
-def assign_workspace_to_dataflow_storage(
-    dataflow_storage_account: str, workspace: Optional[str] = None
-):
-    """
-    Assigns a dataflow storage account to a workspace.
-
-    Parameters
-    ----------
-    dataflow_storage_account : str
-        The name of the dataflow storage account.
-    workspace : str, default=None
-        The name 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
-    -------
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    df = list_dataflow_storage_accounts()
-    df_filt = df[df["Dataflow Storage Account Name"] == dataflow_storage_account]
-    dataflow_storage_id = df_filt["Dataflow Storage Account ID"].iloc[0]
-
-    client = fabric.PowerBIRestClient()
-
-    request_body = {"dataflowStorageId": dataflow_storage_id}
-
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/AssignToDataflowStorage", json=request_body
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    print(
-        f"{icons.green_dot} The '{dataflow_storage_account}' dataflow storage account has been assigned to the '{workspace}' workspacce."
-    )
-
-
-def list_capacities() -> pd.DataFrame:
-    """
-    Shows the capacities and their properties.
-
-    Parameters
-    ----------
-
-    Returns
-    -------
-    pandas.DataFrame
-        A pandas dataframe showing the capacities and their properties
-    """
-
-    df = pd.DataFrame(
-        columns=["Id", "Display Name", "Sku", "Region", "State", "Admins"]
-    )
-
-    client = fabric.PowerBIRestClient()
-    response = client.get("/v1.0/myorg/capacities")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    for i in response.json().get("value", []):
-        new_data = {
-            "Id": i.get("id").lower(),
-            "Display Name": i.get("displayName"),
-            "Sku": i.get("sku"),
-            "Region": i.get("region"),
-            "State": i.get("state"),
-            "Admins": [i.get("admins", [])],
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
-
-
-def get_notebook_definition(
-    notebook_name: str, workspace: Optional[str] = None, decode: Optional[bool] = True
-):
-    """
-    Obtains the notebook definition.
-
-    Parameters
-    ----------
-    notebook_name : str
-        The name of the notebook.
-    workspace : str, default=None
-        The name 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.
-    decode : bool, default=True
-        If True, decodes the notebook definition file into .ipynb format.
-        If False, obtains the notebook definition file in base64 format.
-
-    Returns
-    -------
-    ipynb
-        The notebook definition.
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    dfI = fabric.list_items(workspace=workspace, type="Notebook")
-    dfI_filt = dfI[dfI["Display Name"] == notebook_name]
-
-    if len(dfI_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{notebook_name}' notebook does not exist within the '{workspace}' workspace."
-        )
-
-    notebook_id = dfI_filt["Id"].iloc[0]
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"v1/workspaces/{workspace_id}/notebooks/{notebook_id}/getDefinition",
-    )
-
-    result = lro(client, response).json()
-    df_items = pd.json_normalize(result["definition"]["parts"])
-    df_items_filt = df_items[df_items["path"] == "notebook-content.py"]
-    payload = df_items_filt["payload"].iloc[0]
-
-    if decode:
-        result = _decode_b64(payload)
-    else:
-        result = payload
-
-    return result
-
-
-def import_notebook_from_web(
-    notebook_name: str,
-    url: str,
-    description: Optional[str] = None,
-    workspace: Optional[str] = None,
-):
-    """
-    Creates a new notebook within a workspace based on a Jupyter notebook hosted in the web.
-
-    Parameters
-    ----------
-    notebook_name : str
-        The name of the notebook to be created.
-    url : str
-        The url of the Jupyter Notebook (.ipynb)
-    description : str, default=None
-        The description of the notebook.
-        Defaults to None which does not place a description.
-    workspace : str, default=None
-        The name 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
-    -------
-    """
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
-    client = fabric.FabricRestClient()
-    dfI = fabric.list_items(workspace=workspace, type="Notebook")
-    dfI_filt = dfI[dfI["Display Name"] == notebook_name]
-    if len(dfI_filt) > 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{notebook_name}' already exists within the '{workspace}' workspace."
-        )
-
-    # Fix links to go to the raw github file
-    starting_text = "https://github.com/"
-    starting_text_len = len(starting_text)
-    if url.startswith(starting_text):
-        url = f"https://raw.githubusercontent.com/{url[starting_text_len:]}".replace(
-            "/blob/", "/"
-        )
-
-    response = requests.get(url)
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    file_content = response.content
-    notebook_payload = base64.b64encode(file_content)
-
-    request_body = {
-        "displayName": notebook_name,
-        "definition": {
-            "format": "ipynb",
-            "parts": [
-                {
-                    "path": "notebook-content.py",
-                    "payload": notebook_payload,
-                    "payloadType": "InlineBase64",
-                }
-            ],
-        },
-    }
-    if description is not None:
-        request_body["description"] = description
-
-    response = client.post(f"v1/workspaces/{workspace_id}/notebooks", json=request_body)
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{notebook_name}' notebook was created within the '{workspace}' workspace."
-    )
-
-
 def list_reports_using_semantic_model(
     dataset: str, workspace: Optional[str] = None
 ) -> pd.DataFrame: