added delete_semantic_model (#557)

* added delete_semantic_model

* added delete_workspace

* added fabric_sp

* date

* added sql_database functions

* fabric_sp

* clean

* list_capacities

* black

* fix

* added schema to get_delta_table_history

* support SP

* black

* updated sqldatabase

* fixed sql

Author: m-kovalsky

README.md

@@ -123,7 +123,7 @@ An even better way to ensure the semantic-link-labs library is available in your
 2. Select your newly created environment within the 'Environment' drop down in the navigation bar at the top of the notebook
 
 ## Version History
-* [0.9.6](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.6) (March 11, 2025)
+* [0.9.6](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.6) (March 12, 2025)
 * [0.9.5](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.5) (March 7, 2025)
 * [0.9.4](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.4) (February 27, 2025)
 * [0.9.3](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.3) (February 13, 2025)

src/sempy_labs/__init__.py

@@ -10,6 +10,7 @@
 from sempy_labs._semantic_models import (
     get_semantic_model_refresh_schedule,
     enable_semantic_model_scheduled_refresh,
+    delete_semantic_model,
 )
 from sempy_labs._graphQL import (
     list_graphql_apis,
@@ -151,6 +152,7 @@
     create_or_update_resource_group,
     list_resource_groups,
     get_resource_group,
+    list_capacities,
 )
 from sempy_labs._spark import (
     get_spark_settings,
@@ -168,6 +170,7 @@
     assign_workspace_to_capacity,
     unassign_workspace_from_capacity,
     list_workspace_role_assignments,
+    delete_workspace,
 )
 from sempy_labs._notebooks import (
     get_notebook_definition,
@@ -183,6 +186,9 @@
 from sempy_labs._sqldatabase import (
     get_sql_database_columns,
     get_sql_database_tables,
+    create_sql_database,
+    delete_sql_database,
+    list_sql_databases,
 )
 from sempy_labs._workspace_identity import (
     provision_workspace_identity,
@@ -247,7 +253,6 @@
     list_semantic_model_objects,
     list_shortcuts,
     get_object_level_security,
-    list_capacities,
     list_datamarts,
     list_lakehouses,
     list_sql_endpoints,
@@ -544,4 +549,9 @@
     "get_mounted_data_factory_definition",
     "delete_mounted_data_factory",
     "generate_dax_query_view_url",
+    "delete_semantic_model",
+    "delete_workspace",
+    "create_sql_database",
+    "delete_sql_database",
+    "list_sql_databases",
 ]

src/sempy_labs/_capacities.py

@@ -242,7 +242,7 @@ def list_vcores() -> pd.DataFrame:
 
 def get_capacity_resource_governance(capacity_name: str):
 
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Display Name"] == capacity_name]
     capacity_id = dfC_filt["Id"].iloc[0].upper()
 
@@ -1131,3 +1131,39 @@ def get_resource_group(azure_subscription_id: str, resource_group: str) -> pd.Da
     }
 
     return pd.DataFrame(new_data, index=[0])
+
+
+def list_capacities() -> pd.DataFrame:
+    """
+    Shows the capacities and their properties.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the capacities and their properties
+    """
+
+    columns = {
+        "Id": "string",
+        "Display Name": "string",
+        "Sku": "string",
+        "Region": "string",
+        "State": "string",
+        "Admins": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    response = _base_api(request="/v1.0/myorg/capacities", client="fabric_sp")
+
+    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

src/sempy_labs/_capacity_migration.py

@@ -106,26 +106,25 @@ def migrate_workspaces(
     migrated_workspaces = []
 
     for i, r in dfW.iterrows():
-        workspace = r["Name"]
-
-        if workspaces is None or workspace in workspaces:
-            pass
-        else:
-            continue
-
-        if assign_workspace_to_capacity(capacity=target_capacity, workspace=workspace):
-            migrated_workspaces.append(workspace)
+        workspace_id = r["Id"]
+        workspace_name = r["Name"]
+        if workspaces is None or workspace_name in workspaces:
+            assign_workspace_to_capacity(
+                capacity=target_capacity, workspace=workspace_id
+            )
+            migrated_workspaces.append(workspace_name)
 
     if len(migrated_workspaces) < workspace_count:
         print(
             f"{icons.warning} Not all workspaces in the '{source_capacity}' capacity were migrated to the '{target_capacity}' capacity."
         )
         print(f"{icons.in_progress} Initiating rollback...")
         for i, r in dfW.iterrows():
-            workspace = r["Name"]
-            if workspace in migrated_workspaces:
+            workspace_id = r["Id"]
+            workspace_name = r["Name"]
+            if workspace_name in migrated_workspaces:
                 assign_workspace_to_capacity(
-                    capacity=source_capacity, workspace=workspace
+                    capacity=source_capacity, workspace=workspace_id
                 )
         print(
             f"{icons.green_dot} Rollback of the workspaces to the '{source_capacity}' capacity is complete."

src/sempy_labs/_connections.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (

src/sempy_labs/_delta_analyzer.py

@@ -429,6 +429,7 @@ def get_delta_table_history(
     table_name: str,
     lakehouse: Optional[str | UUID] = None,
     workspace: Optional[str | UUID] = None,
+    schema: Optional[str] = None,
 ) -> pd.DataFrame:
     """
     Returns the history of a delta table as a pandas dataframe.
@@ -444,6 +445,8 @@ def get_delta_table_history(
         The Fabric workspace name or ID used by the lakehouse.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
+    schema : str, default=None
+        The name of the schema to which the table belongs (for schema-enabled lakehouses). If None, the default schema is used.
 
     Returns
     -------
@@ -460,7 +463,7 @@ def camel_to_title(text):
     (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
         lakehouse=lakehouse, workspace=workspace
     )
-    path = create_abfss_path(lakehouse_id, workspace_id, table_name)
+    path = create_abfss_path(lakehouse_id, workspace_id, table_name, schema)
 
     from delta import DeltaTable
 

src/sempy_labs/_environments.py

@@ -48,6 +48,8 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Environments <https://learn.microsoft.com/rest/api/fabric/environment/items/list-environments>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -71,7 +73,9 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/environments", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/environments",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -113,6 +117,8 @@ def publish_environment(
 
     This is a wrapper function for the following API: `Spark Libraries - Publish Environment <https://learn.microsoft.com/rest/api/fabric/environment/spark-libraries/publish-environment>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     environment: str | uuid.UUID
@@ -133,6 +139,7 @@ def publish_environment(
         method="post",
         lro_return_status_code=True,
         status_codes=None,
+        client="fabric_sp",
     )
 
     print(

src/sempy_labs/_eventhouses.py

@@ -72,6 +72,8 @@ def list_eventhouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Eventhouses <https://learn.microsoft.com/rest/api/fabric/environment/items/list-eventhouses>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -95,7 +97,9 @@ def list_eventhouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventhouses", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/eventhouses",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:

src/sempy_labs/_graphQL.py

@@ -15,6 +15,8 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List GraphQLApis <https://learn.microsoft.com/rest/api/fabric/graphqlapi/items/list-graphqlapi-s>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -38,7 +40,9 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/GraphQLApis", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/GraphQLApis",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:

src/sempy_labs/_helper_functions.py

@@ -1043,12 +1043,13 @@ def resolve_workspace_capacity(
     Tuple[uuid.UUID, str]
         capacity Id; capacity came.
     """
+    from sempy_labs._capacities import list_capacities
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     filter_condition = urllib.parse.quote(workspace_id)
     dfW = fabric.list_workspaces(filter=f"id eq '{filter_condition}'")
     capacity_id = dfW["Capacity Id"].iloc[0]
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Id"] == capacity_id]
     if len(dfC_filt) == 1:
         capacity_name = dfC_filt["Display Name"].iloc[0]
@@ -1106,8 +1107,10 @@ def get_capacity_name(workspace: Optional[str | UUID] = None) -> str:
         The capacity name.
     """
 
+    from sempy_labs._capacities import list_capacities
+
     capacity_id = get_capacity_id(workspace)
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Id"] == capacity_id]
     if dfC_filt.empty:
         raise ValueError(
@@ -1133,11 +1136,12 @@ def resolve_capacity_name(capacity_id: Optional[UUID] = None) -> str:
     str
         The capacity name.
     """
+    from sempy_labs._capacities import list_capacities
 
     if capacity_id is None:
         return get_capacity_name()
 
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Id"] == capacity_id]
 
     if dfC_filt.empty:
@@ -1164,6 +1168,7 @@ def resolve_capacity_id(capacity: Optional[str | UUID] = None, **kwargs) -> UUID
     uuid.UUID
         The capacity Id.
     """
+    from sempy_labs._capacities import list_capacities
 
     if "capacity_name" in kwargs:
         capacity = kwargs["capacity_name"]
@@ -1176,7 +1181,7 @@ def resolve_capacity_id(capacity: Optional[str | UUID] = None, **kwargs) -> UUID
     if _is_valid_uuid(capacity):
         return capacity
 
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Display Name"] == capacity]
 
     if dfC_filt.empty: