semantic-link-labs 0.8.9__py3-none-any.whl → 0.8.11__py3-none-any.whl

sempy_labs/_vertipaq.py

@@ -10,10 +10,11 @@ from pyspark.sql import SparkSession
 from sempy_labs._helper_functions import (
     format_dax_object_name,
     resolve_lakehouse_name,
-    resolve_dataset_id,
     save_as_delta_table,
     resolve_workspace_capacity,
     _get_max_run_id,
+    resolve_workspace_name_and_id,
+    resolve_dataset_name_and_id,
 )
 from sempy_labs._list_functions import list_relationships, list_tables
 from sempy_labs.lakehouse import lakehouse_attached, get_lakehouse_tables
@@ -22,12 +23,13 @@ from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
 from pathlib import Path
+from uuid import UUID
 
 
 @log
 def vertipaq_analyzer(
-    dataset: str,
-    workspace: Optional[str] = None,
+    dataset: str | UUID,
+    workspace: Optional[str | UUID] = None,
     export: Optional[str] = None,
     read_stats_from_data: bool = False,
     **kwargs,
@@ -37,10 +39,10 @@ def vertipaq_analyzer(
 
     Parameters
     ----------
-    dataset : str
-        Name of the semantic model.
-    workspace : str, default=None
-        The Fabric workspace name in which the semantic model exists.
+    dataset : str | uuid.UUID
+        Name or ID of the semantic model.
+    workspace : str| uuid.UUID, default=None
+        The Fabric workspace name or ID in which the semantic model exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
     export : str, default=None
@@ -49,10 +51,6 @@ def vertipaq_analyzer(
         Default value: None.
     read_stats_from_data : bool, default=False
         Setting this parameter to true has the function get Column Cardinality and Missing Rows using DAX (Direct Lake semantic models achieve this using a Spark query to the lakehouse).
-
-    Returns
-    -------
-
     """
 
     from sempy_labs.tom import connect_semantic_model
@@ -68,7 +66,8 @@ def vertipaq_analyzer(
         "ignore", message="createDataFrame attempted Arrow optimization*"
     )
 
-    workspace = fabric.resolve_workspace_name(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
     vertipaq_map = {
         "Model": {
@@ -135,7 +134,7 @@ def vertipaq_analyzer(
     }
 
     with connect_semantic_model(
-        dataset=dataset, workspace=workspace, readonly=True
+        dataset=dataset_id, workspace=workspace_id, readonly=True
     ) as tom:
         compat_level = tom.model.Model.Database.CompatibilityLevel
         is_direct_lake = tom.is_direct_lake()
@@ -144,24 +143,28 @@ def vertipaq_analyzer(
         column_count = len(list(tom.all_columns()))
         if table_count == 0:
             print(
-                f"{icons.warning} The '{dataset}' semantic model within the '{workspace}' workspace has no tables. Vertipaq Analyzer can only be run if the semantic model has tables."
+                f"{icons.warning} The '{dataset_name}' semantic model within the '{workspace_name}' workspace has no tables. Vertipaq Analyzer can only be run if the semantic model has tables."
             )
             return
 
-    dfT = list_tables(dataset=dataset, extended=True, workspace=workspace)
+    dfT = list_tables(dataset=dataset_id, extended=True, workspace=workspace_id)
 
     dfT.rename(columns={"Name": "Table Name"}, inplace=True)
     columns_to_keep = list(vertipaq_map["Tables"].keys())
     dfT = dfT[dfT.columns.intersection(columns_to_keep)]
 
-    dfC = fabric.list_columns(dataset=dataset, extended=True, workspace=workspace)
+    dfC = fabric.list_columns(dataset=dataset_id, extended=True, workspace=workspace_id)
     dfC["Column Object"] = format_dax_object_name(dfC["Table Name"], dfC["Column Name"])
     dfC.rename(columns={"Column Cardinality": "Cardinality"}, inplace=True)
-    dfH = fabric.list_hierarchies(dataset=dataset, extended=True, workspace=workspace)
-    dfR = list_relationships(dataset=dataset, extended=True, workspace=workspace)
-    dfP = fabric.list_partitions(dataset=dataset, extended=True, workspace=workspace)
+    dfH = fabric.list_hierarchies(
+        dataset=dataset_id, extended=True, workspace=workspace_id
+    )
+    dfR = list_relationships(dataset=dataset_id, extended=True, workspace=workspace_id)
+    dfP = fabric.list_partitions(
+        dataset=dataset_id, extended=True, workspace=workspace_id
+    )
     artifact_type, lakehouse_name, lakehouse_id, lakehouse_workspace_id = (
-        get_direct_lake_source(dataset=dataset, workspace=workspace)
+        get_direct_lake_source(dataset=dataset_id, workspace=workspace_id)
     )
 
     dfR["Missing Rows"] = 0
@@ -308,7 +311,7 @@ def vertipaq_analyzer(
                     query = f"evaluate\nsummarizecolumns(\n\"1\",calculate(countrows('{fromTable}'),userelationship({fromObject},{toObject}),isblank({toObject}))\n)"
 
                 result = fabric.evaluate_dax(
-                    dataset=dataset, dax_string=query, workspace=workspace
+                    dataset=dataset_id, dax_string=query, workspace=workspace_id
                 )
 
                 try:
@@ -407,7 +410,7 @@ def vertipaq_analyzer(
 
     dfModel = pd.DataFrame(
         {
-            "Dataset Name": dataset,
+            "Dataset Name": dataset_name,
             "Total Size": y,
             "Table Count": table_count,
             "Column Count": column_count,
@@ -532,19 +535,19 @@ def vertipaq_analyzer(
             f"{icons.in_progress} Saving Vertipaq Analyzer to delta tables in the lakehouse...\n"
         )
         now = datetime.datetime.now()
-        dfD = fabric.list_datasets(workspace=workspace, mode="rest")
-        dfD_filt = dfD[dfD["Dataset Name"] == dataset]
+        dfD = fabric.list_datasets(workspace=workspace_id, mode="rest")
+        dfD_filt = dfD[dfD["Dataset Id"] == dataset_id]
         configured_by = dfD_filt["Configured By"].iloc[0]
-        capacity_id, capacity_name = resolve_workspace_capacity(workspace=workspace)
+        capacity_id, capacity_name = resolve_workspace_capacity(workspace=workspace_id)
 
         for key_name, (obj, df) in dfMap.items():
             df["Capacity Name"] = capacity_name
             df["Capacity Id"] = capacity_id
             df["Configured By"] = configured_by
-            df["Workspace Name"] = workspace
-            df["Workspace Id"] = fabric.resolve_workspace_id(workspace)
-            df["Dataset Name"] = dataset
-            df["Dataset Id"] = resolve_dataset_id(dataset, workspace)
+            df["Workspace Name"] = workspace_name
+            df["Workspace Id"] = workspace_id
+            df["Dataset Name"] = dataset_name
+            df["Dataset Id"] = dataset_id
             df["RunId"] = runId
             df["Timestamp"] = now
 
@@ -605,7 +608,7 @@ def vertipaq_analyzer(
             "dfH_filt": dfH_filt,
         }
 
-        zipFileName = f"{workspace}.{dataset}.zip"
+        zipFileName = f"{workspace_name}.{dataset_name}.zip"
 
         folderPath = "/lakehouse/default/Files"
         subFolderPath = os.path.join(folderPath, "VertipaqAnalyzer")
@@ -631,7 +634,7 @@ def vertipaq_analyzer(
             if os.path.exists(filePath):
                 os.remove(filePath)
         print(
-            f"{icons.green_dot} The Vertipaq Analyzer info for the '{dataset}' semantic model in the '{workspace}' workspace has been saved "
+            f"{icons.green_dot} The Vertipaq Analyzer info for the '{dataset_name}' semantic model in the '{workspace_name}' workspace has been saved "
             f"to the 'Vertipaq Analyzer/{zipFileName}' in the default lakehouse attached to this notebook."
         )
 

sempy_labs/_warehouses.py

@@ -8,13 +8,14 @@ import pandas as pd
 from typing import Optional
 import sempy_labs._icons as icons
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
 def create_warehouse(
     warehouse: str,
     description: Optional[str] = None,
     case_insensitive_collation: bool = False,
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Creates a Fabric warehouse.
@@ -29,13 +30,13 @@ def create_warehouse(
         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.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     request_body = {"displayName": warehouse}
 
@@ -55,11 +56,11 @@ def create_warehouse(
     lro(client, response, status_codes=[201, 202])
 
     print(
-        f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace}' workspace."
+        f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace_name}' workspace."
     )
 
 
-def list_warehouses(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the warehouses within a workspace.
 
@@ -67,8 +68,8 @@ def list_warehouses(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
 
@@ -89,7 +90,7 @@ def list_warehouses(workspace: Optional[str] = None) -> pd.DataFrame:
         ]
     )
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.get(f"/v1/workspaces/{workspace_id}/warehouses")
@@ -115,7 +116,7 @@ def list_warehouses(workspace: Optional[str] = None) -> pd.DataFrame:
     return df
 
 
-def delete_warehouse(name: str, workspace: Optional[str] = None):
+def delete_warehouse(name: str, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric warehouse.
 
@@ -125,16 +126,16 @@ def delete_warehouse(name: str, workspace: Optional[str] = None):
     ----------
     name: str
         Name of the warehouse.
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     item_id = fabric.resolve_item_id(
-        item_name=name, type="Warehouse", workspace=workspace
+        item_name=name, type="Warehouse", workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -144,12 +145,12 @@ def delete_warehouse(name: str, workspace: Optional[str] = None):
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{name}' warehouse within the '{workspace}' workspace has been deleted."
+        f"{icons.green_dot} The '{name}' warehouse within the '{workspace_name}' workspace has been deleted."
     )
 
 
 def get_warehouse_tables(
-    warehouse: str, workspace: Optional[str] = None
+    warehouse: str, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
     """
     Shows a list of the tables in the Fabric warehouse. This function is based on INFORMATION_SCHEMA.TABLES.
@@ -158,8 +159,8 @@ def get_warehouse_tables(
     ----------
     warehouse : str
         Name of the Fabric warehouse.
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
 
@@ -184,7 +185,7 @@ def get_warehouse_tables(
 
 
 def get_warehouse_columns(
-    warehouse: str, workspace: Optional[str] = None
+    warehouse: str, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
     """
     Shows a list of the columns in each table within the Fabric warehouse. This function is based on INFORMATION_SCHEMA.COLUMNS.
@@ -193,8 +194,8 @@ def get_warehouse_columns(
     ----------
     warehouse : str
         Name of the Fabric warehouse.
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
 

sempy_labs/_workspace_identity.py

@@ -6,9 +6,10 @@ from sempy_labs._helper_functions import (
 from typing import Optional
 import sempy_labs._icons as icons
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
-def provision_workspace_identity(workspace: Optional[str] = None):
+def provision_workspace_identity(workspace: Optional[str | UUID] = None):
     """
     Provisions a workspace identity for a workspace.
 
@@ -16,13 +17,13 @@ def provision_workspace_identity(workspace: Optional[str] = None):
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.post(f"/v1/workspaces/{workspace_id}/provisionIdentity")
@@ -33,11 +34,11 @@ def provision_workspace_identity(workspace: Optional[str] = None):
     lro(client, response)
 
     print(
-        f"{icons.green_dot} A workspace identity has been provisioned for the '{workspace}' workspace."
+        f"{icons.green_dot} A workspace identity has been provisioned for the '{workspace_name}' workspace."
     )
 
 
-def deprovision_workspace_identity(workspace: Optional[str] = None):
+def deprovision_workspace_identity(workspace: Optional[str | UUID] = None):
     """
     Deprovisions a workspace identity for a workspace.
 
@@ -45,13 +46,13 @@ def deprovision_workspace_identity(workspace: Optional[str] = None):
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.post(f"/v1/workspaces/{workspace_id}/deprovisionIdentity")
@@ -62,5 +63,5 @@ def deprovision_workspace_identity(workspace: Optional[str] = None):
     lro(client, response)
 
     print(
-        f"{icons.green_dot} The workspace identity has been deprovisioned from the '{workspace}' workspace."
+        f"{icons.green_dot} The workspace identity has been deprovisioned from the '{workspace_name}' workspace."
     )

sempy_labs/_workspaces.py

@@ -8,9 +8,12 @@ from sempy_labs._helper_functions import (
     resolve_capacity_id,
 )
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
-def delete_user_from_workspace(email_address: str, workspace: Optional[str] = None):
+def delete_user_from_workspace(
+    email_address: str, workspace: Optional[str | UUID] = None
+):
     """
     Removes a user from a workspace.
 
@@ -20,13 +23,13 @@ def delete_user_from_workspace(email_address: str, workspace: Optional[str] = No
     ----------
     email_address : str
         The email address of the user.
-    workspace : str, default=None
-        The name of the workspace.
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.PowerBIRestClient()
     response = client.delete(f"/v1.0/myorg/groups/{workspace_id}/users/{email_address}")
@@ -34,7 +37,7 @@ def delete_user_from_workspace(email_address: str, workspace: Optional[str] = No
     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."
+        f"{icons.green_dot} The '{email_address}' user has been removed from accessing the '{workspace_name}' workspace."
     )
 
 
@@ -42,7 +45,7 @@ def update_workspace_user(
     email_address: str,
     role_name: str,
     principal_type: Optional[str] = "User",
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Updates a user's role within a workspace.
@@ -57,13 +60,13 @@ def update_workspace_user(
         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.
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     role_names = icons.workspace_roles
     role_name = role_name.capitalize()
@@ -91,11 +94,11 @@ def update_workspace_user(
     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."
+        f"{icons.green_dot} The '{email_address}' user has been updated to a '{role_name}' within the '{workspace_name}' workspace."
     )
 
 
-def list_workspace_users(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_workspace_users(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     A list of all the users of a workspace and their roles.
 
@@ -103,8 +106,8 @@ def list_workspace_users(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The name of the workspace.
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
 
@@ -114,7 +117,7 @@ def list_workspace_users(workspace: Optional[str] = None) -> pd.DataFrame:
         A pandas dataframe the users of a workspace and their properties.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     df = pd.DataFrame(columns=["User Name", "Email Address", "Role", "Type", "User ID"])
     client = fabric.FabricRestClient()
@@ -143,7 +146,7 @@ def add_user_to_workspace(
     email_address: str,
     role_name: str,
     principal_type: Optional[str] = "User",
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Adds a user to a workspace.
@@ -158,13 +161,13 @@ def add_user_to_workspace(
         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.
+    workspace : str | uuid.UUID, default=None
+        The name or ID of the workspace.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     role_names = icons.workspace_roles
     role_name = role_name.capitalize()
@@ -196,11 +199,13 @@ def add_user_to_workspace(
     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."
+        f"{icons.green_dot} The '{email_address}' user has been added as a{plural} '{role_name}' within the '{workspace_name}' workspace."
     )
 
 
-def assign_workspace_to_capacity(capacity_name: str, workspace: Optional[str] = None):
+def assign_workspace_to_capacity(
+    capacity_name: str, workspace: Optional[str | UUID] = None
+):
     """
     Assigns a workspace to a capacity.
 
@@ -210,13 +215,13 @@ def assign_workspace_to_capacity(capacity_name: str, workspace: Optional[str] =
     ----------
     capacity_name : str
         The name of the capacity.
-    workspace : str, default=None
-        The name of the Fabric workspace.
+    workspace : str | uuid.UUID, default=None
+        The name or ID 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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     capacity_id = resolve_capacity_id(capacity_name=capacity_name)
 
     request_body = {"capacityId": capacity_id}
@@ -230,11 +235,11 @@ def assign_workspace_to_capacity(capacity_name: str, workspace: Optional[str] =
     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."
+        f"{icons.green_dot} The '{workspace_name}' workspace has been assigned to the '{capacity_name}' capacity."
     )
 
 
-def unassign_workspace_from_capacity(workspace: Optional[str] = None):
+def unassign_workspace_from_capacity(workspace: Optional[str | UUID] = None):
     """
     Unassigns a workspace from its assigned capacity.
 
@@ -242,13 +247,13 @@ def unassign_workspace_from_capacity(workspace: Optional[str] = None):
 
     Parameters
     ----------
-    workspace : str, default=None
-        The name of the Fabric workspace.
+    workspace : str | uuid.UUID, default=None
+        The name or ID 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)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.post(f"/v1/workspaces/{workspace_id}/unassignFromCapacity")
@@ -256,11 +261,13 @@ def unassign_workspace_from_capacity(workspace: Optional[str] = None):
     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."
+        f"{icons.green_dot} The '{workspace_name}' workspace has been unassigned from its capacity."
     )
 
 
-def list_workspace_role_assignments(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_workspace_role_assignments(
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
     """
     Shows the members of a given workspace.
 
@@ -268,8 +275,8 @@ def list_workspace_role_assignments(workspace: Optional[str] = None) -> pd.DataF
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
 
@@ -279,7 +286,7 @@ def list_workspace_role_assignments(workspace: Optional[str] = None) -> pd.DataF
         A pandas dataframe showing the members of a given workspace and their roles.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     df = pd.DataFrame(columns=["User Name", "User Email", "Role Name", "Type"])
 

sempy_labs/admin/__init__.py

@@ -1,3 +1,6 @@
+from sempy_labs.admin._scanner import (
+    scan_workspaces,
+)
 from sempy_labs.admin._basic_functions import (
     assign_workspaces_to_capacity,
     unassign_workspaces_from_capacity,
@@ -66,4 +69,5 @@ __all__ = [
     "list_git_connections",
     "list_reports",
     "get_capacity_assignment_status",
+    "scan_workspaces",
 ]