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

sempy_labs/_notebooks.py

@@ -0,0 +1,143 @@
+import sempy.fabric as fabric
+import pandas as pd
+import sempy_labs._icons as icons
+from typing import Optional
+import base64
+import requests
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+    lro,
+    _decode_b64,
+)
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+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.
+
+    Note: When specifying a notebook from GitHub, please use the raw file path. Note that if the non-raw file path is specified, the url will be
+    converted to the raw URL as the raw URL is needed to obtain the notebook content.
+
+    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."
+    )

sempy_labs/_query_scale_out.py

@@ -293,13 +293,24 @@ def set_semantic_model_storage_format(
             f"{icons.red_dot} Invalid storage format value. Valid options: {storageFormats}."
         )
 
+    dfL = list_qso_settings(dataset=dataset, workspace=workspace)
+    current_storage_format = dfL["Storage Mode"].iloc[0]
+
+    if current_storage_format == storage_format:
+        print(
+            f"{icons.info} The '{dataset}' semantic model within the '{workspace}' workspace is already set to '{storage_format.lower()}' storage format."
+        )
+        return
+
     client = fabric.PowerBIRestClient()
     response = client.patch(
         f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}", json=request_body
     )
     if response.status_code != 200:
         raise FabricHTTPException(response)
-    print(f"{icons.green_dot} Semantic model storage format set to '{storage_format}'.")
+    print(
+        f"{icons.green_dot} The semantic model storage format for the '{dataset}' semantic model within the '{workspace}' workspace has been set to '{storage_format}'."
+    )
 
 
 def list_qso_settings(
@@ -383,10 +394,6 @@ def set_workspace_default_storage_format(
         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
-    -------
-
     """
 
     # https://learn.microsoft.com/en-us/rest/api/power-bi/groups/update-group#defaultdatasetstorageformat
@@ -396,19 +403,33 @@ def set_workspace_default_storage_format(
     storage_format = storage_format.capitalize()
 
     if storage_format not in storageFormats:
-        print(
+        raise ValueError(
             f"{icons.red_dot} Invalid storage format. Please choose from these options: {storageFormats}."
         )
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"name": workspace, "defaultDatasetStorageFormat": storage_format}
+    # Check current storage format
+    dfW = fabric.list_workspaces(filter=f"name eq '{workspace}'")
+    if len(dfW) == 0:
+        raise ValueError()
+    current_storage_format = dfW['Default Dataset Storage Format'].iloc[0]
+
+    if current_storage_format == storage_format:
+        print(f"{icons.info} The '{workspace}' is already set to a default storage format of '{current_storage_format}'.")
+        return
+
+    request_body = {
+        "name": workspace,
+        "defaultDatasetStorageFormat": storage_format,
+    }
 
     client = fabric.PowerBIRestClient()
     response = client.patch(f"/v1.0/myorg/groups/{workspace_id}", json=request_body)
 
     if response.status_code != 200:
         raise FabricHTTPException(response)
+
     print(
         f"{icons.green_dot} The default storage format for the '{workspace}' workspace has been updated to '{storage_format}."
     )

sempy_labs/_spark.py

@@ -0,0 +1,465 @@
+import sempy.fabric as fabric
+import pandas as pd
+import sempy_labs._icons as icons
+from typing import Optional
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+)
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def list_custom_pools(workspace: Optional[str] = None) -> pd.DataFrame:
+    """
+    Lists all `custom pools <https://learn.microsoft.com/fabric/data-engineering/create-custom-spark-pools>`_ within 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 all the custom pools within the Fabric workspace.
+    """
+
+    # 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",
+        ]
+    )
+
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/workspaces/{workspace_id}/spark/pools")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    for i in response.json()["value"]:
+
+        aScale = i.get("autoScale", {})
+        d = i.get("dynamicExecutorAllocation", {})
+
+        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"),
+        }
+        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.
+    """
+
+    # 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
+    )
+
+    if response.status_code != 201:
+        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.
+    """
+
+    # 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.
+    """
+
+    (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 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.
+    """
+
+    # 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."
+    )