Merge branch 'm-kovalsky/delete_external_data_share'

Author: m-kovalsky

src/sempy_labs/__init__.py

@@ -91,6 +91,7 @@
     list_external_data_shares_in_item,
     create_external_data_share,
     revoke_external_data_share,
+    delete_external_data_share,
 )
 from ._ml_models import (
     list_ml_models,
@@ -498,6 +499,7 @@
     "list_external_data_shares_in_item",
     "create_external_data_share",
     "revoke_external_data_share",
+    "delete_external_data_share",
     "migrate_fabric_trial_capacity",
     "create_resource_group",
     "list_workloads",

src/sempy_labs/_external_data_shares.py

@@ -7,6 +7,8 @@
     _base_api,
     _create_dataframe,
     resolve_item_id,
+    resolve_item_name_and_id,
+    resolve_workspace_id,
 )
 from sempy._utils._log import log
 
@@ -24,6 +26,8 @@ def create_external_data_share(
 
     This is a wrapper function for the following API: `External Data Shares - Create External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/create-external-data-share>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     item_name : str
@@ -53,6 +57,7 @@ def create_external_data_share(
         method="post",
         status_codes=201,
         payload=payload,
+        client="fabric_sp",
     )
     print(
         f"{icons.green_dot} An external data share was created for the '{item_name}' {item_type} within the '{workspace_name}' workspace for the {paths} paths."
@@ -71,6 +76,8 @@ def revoke_external_data_share(
 
     This is a wrapper function for the following API: `External Data Shares - Revoke External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/revoke-external-data-share`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     external_data_share_id : uuid.UUID
@@ -91,6 +98,7 @@ def revoke_external_data_share(
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke",
         method="post",
+        client="fabric_sp",
     )
     print(
         f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
@@ -106,6 +114,8 @@ def list_external_data_shares_in_item(
 
     This is a wrapper function for the following API: `External Data Shares - List External Data Shares In Item <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares/list-external-data-shares-in-item`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     item_name : str
@@ -123,7 +133,7 @@ def list_external_data_shares_in_item(
         A pandas dataframe showing a list of the external data shares that exist for the specified item.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
     item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     columns = {
@@ -145,6 +155,7 @@ def list_external_data_shares_in_item(
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares",
         uses_pagination=True,
+        client="fabric_sp",
     )
 
     rows = []
@@ -174,3 +185,46 @@ def list_external_data_shares_in_item(
         df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
+
+
+@log
+def delete_external_data_share(
+    external_data_share_id: UUID,
+    item: str | UUID,
+    item_type: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Deletes the specified external data share.
+
+    This is a wrapper function for the following API: `External Data Shares Provider - Delete External Data Share <https://learn.microsoft.com/rest/api/fabric/core/external-data-shares-provider/delete-external-data-share`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    external_data_share_id : uuid.UUID
+        The external data share ID.
+    item : str | uuid.UUID
+        The item name or ID.
+    item_type : str
+        The `item type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_.
+    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_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=item_type, workspace=workspace_id
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}",
+        method="delete",
+        client="fabric_sp",
+    )
+    print(
+        f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
+    )

src/sempy_labs/report/_reportwrapper.py

@@ -2083,7 +2083,7 @@ def remove_unnecessary_custom_visuals(self):
             item for item in custom_visuals if item not in cv_remove
         ]
         self.set_json(
-            file_path=self._report_path,
+            file_path=self._report_file_path,
             json_path=json_path,
             json_value=updated_custom_visuals,
         )