semantic-link-labs 0.11.1__py3-none-any.whl → 0.11.3__py3-none-any.whl

sempy_labs/_external_data_shares.py

@@ -2,11 +2,13 @@ from uuid import UUID
 import pandas as pd
 from typing import Optional, List
 import sempy_labs._icons as icons
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _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,31 +155,76 @@ 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",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for i in r.get("value", []):
             item_id = i.get("itemId")
-            new_data = {
-                "External Data Share Id": i.get("id"),
-                "Paths": [i.get("paths")],
-                "Creator Principal Id": i.get("creatorPrincipal", {}).get("id"),
-                "Creator Principal Type": i.get("creatorPrincipal", {}).get("type"),
-                "Recipient User Principal Name": i.get("recipient", {}).get(
-                    "userPrincipalName"
-                ),
-                "Status": i.get("status"),
-                "Expiration Time UTC": i.get("expriationTimeUtc"),
-                "Workspace Id": i.get("workspaceId"),
-                "Item Id": item_id,
-                "Item Name": item_name,
-                "Item Type": item_type,
-                "Invitation URL": i.get("invitationUrl"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "External Data Share Id": i.get("id"),
+                    "Paths": [i.get("paths")],
+                    "Creator Principal Id": i.get("creatorPrincipal", {}).get("id"),
+                    "Creator Principal Type": i.get("creatorPrincipal", {}).get("type"),
+                    "Recipient User Principal Name": i.get("recipient", {}).get(
+                        "userPrincipalName"
+                    ),
+                    "Status": i.get("status"),
+                    "Expiration Time UTC": i.get("expriationTimeUtc"),
+                    "Workspace Id": i.get("workspaceId"),
+                    "Item Id": item_id,
+                    "Item Name": item_name,
+                    "Item Type": item_type,
+                    "Invitation URL": i.get("invitationUrl"),
+                }
+            )
+
+    if rows:
+        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."
+    )

sempy_labs/_gateways.py

@@ -1,7 +1,7 @@
 from sempy._utils._log import log
 import pandas as pd
 from typing import Optional
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _is_valid_uuid,
     resolve_capacity_id,
     resolve_workspace_name_and_id,
@@ -47,26 +47,28 @@ def list_gateways() -> pd.DataFrame:
         request="/v1/gateways", client="fabric_sp", uses_pagination=True
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Gateway Name": v.get("displayName"),
-                "Gateway Id": v.get("id"),
-                "Type": v.get("type"),
-                "Public Key Exponent": v.get("publicKey", {}).get("exponent"),
-                "Public Key Modulus": v.get("publicKey", {}).get("modulus"),
-                "Version": v.get("version"),
-                "Number Of Member Gateways": v.get("numberOfMemberGateways", 0),
-                "Load Balancing Setting": v.get("loadBalancingSetting"),
-                "Allow Cloud Connection Refresh": v.get("allowCloudConnectionRefresh"),
-                "Allow Custom Connectors": v.get("allowCustomConnectors"),
-            }
-
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Gateway Name": v.get("displayName"),
+                    "Gateway Id": v.get("id"),
+                    "Type": v.get("type"),
+                    "Public Key Exponent": v.get("publicKey", {}).get("exponent"),
+                    "Public Key Modulus": v.get("publicKey", {}).get("modulus"),
+                    "Version": v.get("version"),
+                    "Number Of Member Gateways": v.get("numberOfMemberGateways", 0),
+                    "Load Balancing Setting": v.get("loadBalancingSetting"),
+                    "Allow Cloud Connection Refresh": v.get(
+                        "allowCloudConnectionRefresh"
+                    ),
+                    "Allow Custom Connectors": v.get("allowCustomConnectors"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
@@ -141,20 +143,20 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
         uses_pagination=True,
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Gateway Role Assignment Id": v.get("id"),
-                "Principal Id": v.get("principal", {}).get("id"),
-                "Principal Type": v.get("principal", {}).get("type"),
-                "Role": v.get("role"),
-            }
-
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "Gateway Role Assignment Id": v.get("id"),
+                    "Principal Id": v.get("principal", {}).get("id"),
+                    "Principal Type": v.get("principal", {}).get("type"),
+                    "Role": v.get("role"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 
@@ -274,21 +276,21 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
         request=f"/v1/gateways/{gateway_id}/members", client="fabric_sp"
     )
 
-    dfs = []
+    rows = []
     for v in response.json().get("value", []):
-        new_data = {
-            "Member Id": v.get("id"),
-            "Member Name": v.get("displayName"),
-            "Public Key Exponent": v.get("publicKey", {}).get("exponent"),
-            "Public Key Modulus": v.get("publicKey", {}).get("modulus"),
-            "Version": v.get("version"),
-            "Enabled": v.get("enabled"),
-        }
-
-        dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+        rows.append(
+            {
+                "Member Id": v.get("id"),
+                "Member Name": v.get("displayName"),
+                "Public Key Exponent": v.get("publicKey", {}).get("exponent"),
+                "Public Key Modulus": v.get("publicKey", {}).get("modulus"),
+                "Version": v.get("version"),
+                "Enabled": v.get("enabled"),
+            }
+        )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df

sempy_labs/_generate_semantic_model.py

@@ -4,7 +4,7 @@ import json
 import os
 from typing import Optional, List
 from sempy._utils._log import log
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     _conv_b64,
@@ -13,9 +13,9 @@ from sempy_labs._helper_functions import (
     _mount,
     resolve_workspace_id,
 )
-from sempy_labs.lakehouse._lakehouse import lakehouse_attached
+from .lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
-from sempy_labs._refresh_semantic_model import refresh_semantic_model
+from ._refresh_semantic_model import refresh_semantic_model
 from uuid import UUID
 
 

sempy_labs/_git.py

@@ -1,7 +1,7 @@
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional, List
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,

sempy_labs/_graphQL.py

@@ -1,7 +1,7 @@
 import pandas as pd
 from uuid import UUID
 from typing import Optional
-from sempy_labs._helper_functions import (
+from ._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_id,
@@ -47,18 +47,19 @@ def list_graphql_apis(workspace: Optional[str | UUID]) -> pd.DataFrame:
         client="fabric_sp",
     )
 
-    dfs = []
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "GraphQL API Name": v.get("displayName"),
-                "GraphQL API Id": v.get("id"),
-                "Description": v.get("description"),
-            }
-            dfs.append(pd.DataFrame(new_data, index=[0]))
-
-    if dfs:
-        df = pd.concat(dfs, ignore_index=True)
+            rows.append(
+                {
+                    "GraphQL API Name": v.get("displayName"),
+                    "GraphQL API Id": v.get("id"),
+                    "Description": v.get("description"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
 

sempy_labs/_helper_functions.py

@@ -20,6 +20,7 @@ import sempy_labs._authentication as auth
 from jsonpath_ng.ext import parse
 from jsonpath_ng.jsonpath import Fields, Index
 from sempy._utils._log import log
+from os import PathLike
 
 
 def _build_url(url: str, params: dict) -> str:
@@ -238,6 +239,18 @@ def delete_item(
     )
 
 
+@log
+def create_folder_if_not_exists(
+    folder: str | PathLike, workspace: Optional[str | UUID] = None
+) -> UUID:
+    try:
+        x = fabric.resolve_folder_id(folder=folder, workspace=workspace)
+    except:
+        x = fabric.create_folder(folder=folder, workspace=workspace)
+
+    return x
+
+
 @log
 def create_item(
     name: str,
@@ -245,6 +258,7 @@ def create_item(
     description: Optional[str] = None,
     definition: Optional[dict] = None,
     workspace: Optional[str | UUID] = None,
+    folder: Optional[str | PathLike] = None,
 ):
     """
     Creates an item in a Fabric workspace.
@@ -263,6 +277,9 @@ def create_item(
         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.
+    folder : str | os.PathLike, default=None
+        The folder within the workspace where the item will be created.
+        Defaults to None which places the item in the root of the workspace.
     """
     from sempy_labs._utils import item_types
 
@@ -277,6 +294,10 @@ def create_item(
         payload["description"] = description
     if definition:
         payload["definition"] = definition
+    if folder:
+        payload["folderId"] = create_folder_if_not_exists(
+            folder=folder, workspace=workspace_id
+        )
 
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/{item_type_url}",
@@ -290,6 +311,146 @@ def create_item(
     )
 
 
+@log
+def copy_item(
+    item: str | UUID,
+    type: str,
+    target_name: Optional[str] = None,
+    source_workspace: Optional[str | UUID] = None,
+    target_workspace: Optional[str | UUID] = None,
+    overwrite: bool = False,
+):
+    """
+    Copies an item (with its definition) from one location to another location.
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The name or ID of the item to be copied.
+    type : str
+        The type of the item.
+    target_name: str, default=None
+        The name of the item in the target workspace. Defaults to the same name as the source item.
+    source_workspace : str | uuid.UUID, default=None
+        The workspace name or ID in which the item 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.
+    target_workspace : str | uuid.UUID, default=None
+        The workspace name or ID to which the item will be copied.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    overwrite: bool, default=False
+        If True, overwrites the item in the target workspace if it already exists.
+    """
+
+    items = {
+        "CopyJob": "copyJobs",
+        "Dataflow": "dataflows",
+        "Eventhouse": "eventhouses",
+        "GraphQLApi": "GraphQLApis",
+        "Report": "reports",
+        "SemanticModel": "semanticModels",
+        # "Environment": "environments",
+        "KQLDatabase": "kqlDatabases",
+        "KQLDashboard": "kqlDashboards",
+        "KQLQueryset": "kqlQuerysets",
+        "DataPipeline": "dataPipelines",
+        "Notebook": "notebooks",
+        "SparkJobDefinition": "sparkJobDefinitions",
+        "Eventstream": "eventstreams",
+        "MirroredWarehouse": "mirroredWarehouses",
+        "MirroredDatabase": "mirroredDatabases",
+        "MountedDataFactory": "mountedDataFactories",
+        "VariableLibrary": "variableLibraries",
+        "ApacheAirFlowJob": "ApacheAirflowJobs",
+        "WarehouseSnapshot": "warehousesnapshots",
+        "DigitalTwinBuilder": "digitaltwinbuilders",
+        "DigitalTwinBuilderFlow": "DigitalTwinBuilderFlows",
+        "MirroredAzureDatabricksCatalog": "mirroredAzureDatabricksCatalogs",
+    }
+    if type not in items:
+        raise ValueError(
+            f"{icons.red_dot} The '{type}' item type does not have a definition and cannot be copied."
+        )
+    type_url = items.get(type)
+
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=type, workspace=source_workspace
+    )
+    (source_workspace_name, source_workspace_id) = resolve_workspace_name_and_id(
+        source_workspace
+    )
+    (target_workspace_name, target_workspace_id) = resolve_workspace_name_and_id(
+        target_workspace
+    )
+
+    if target_name is None:
+        target_name = item_name
+
+    if source_workspace_id == target_workspace_id and target_name == item_name:
+        raise ValueError(
+            f"{icons.red_dot} The source and target workspaces are the same and the target name is the same as the source name. No action taken."
+        )
+
+    result = _base_api(
+        request=f"v1/workspaces/{source_workspace_id}/{type_url}/{item_id}",
+        client="fabric_sp",
+    )
+    description = result.json().get("description")
+
+    payload = _base_api(
+        request=f"v1/workspaces/{source_workspace_id}/{type_url}/{item_id}/getDefinition",
+        method="post",
+        client="fabric_sp",
+        status_codes=None,
+        lro_return_json=True,
+    )
+    payload["displayName"] = target_name
+    if description:
+        payload["description"] = description
+
+    # Check if item exists in target workspace
+    exists = False
+    try:
+        target_item_id = resolve_item_id(
+            item=target_name, type=type, workspace=target_workspace_id
+        )
+        exists = True
+    except Exception:
+        exists = False
+
+    if exists and not overwrite:
+        raise ValueError(
+            f"{icons.warning} The item '{target_name}' of type '{type}' already exists in the target workspace '{target_workspace_name}' and overwrite is set to False."
+        )
+    elif exists and overwrite:
+        # Update item definition
+        print(
+            f"{icons.in_progress} Updating existing item '{target_name}' of type '{type}' in the target workspace '{target_workspace_name}'..."
+        )
+        _base_api(
+            request=f"/v1/workspaces/{target_workspace_id}/{type_url}/{target_item_id}/updateDefinition",
+            method="post",
+            client="fabric_sp",
+            payload=payload,
+            lro_return_status_code=True,
+            status_codes=None,
+        )
+        print(
+            f"{icons.green_dot} The item '{target_name}' of type '{type}' has been successfully updated in the target workspace '{target_workspace_name}'."
+        )
+    else:
+        print(
+            f"{icons.in_progress} Creating new item '{target_name}' of type '{type}' in the target workspace '{target_workspace_name}'..."
+        )
+        create_item(
+            name=target_name,
+            type=type,
+            definition=payload["definition"],
+            workspace=target_workspace_id,
+        )
+
+
 @log
 def get_item_definition(
     item: str | UUID,
@@ -997,15 +1158,15 @@ def _decode_b64(file, format: Optional[str] = "utf-8"):
 
 @log
 def is_default_semantic_model(
-    dataset: str, workspace: Optional[str | UUID] = None
+    dataset: str | UUID, workspace: Optional[str | UUID] = None
 ) -> bool:
     """
     Identifies whether a semantic model is a default semantic model.
 
     Parameters
     ----------
-    dataset : str
-        The name of the semantic model.
+    dataset : str | uuid.UUID
+        The name or ID of the semantic model.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -1017,7 +1178,10 @@ def is_default_semantic_model(
         A True/False value indicating whether the semantic model is a default semantic model.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
+    (dataset_name, dataset_id) = resolve_item_name_and_id(
+        item=dataset, type="SemanticModel", workspace=workspace_id
+    )
 
     dfI = fabric.list_items(workspace=workspace_id)
     filtered_df = dfI.groupby("Display Name").filter(
@@ -1026,7 +1190,7 @@ def is_default_semantic_model(
     )
     default_semantic_models = filtered_df["Display Name"].unique().tolist()
 
-    return dataset in default_semantic_models
+    return dataset_name in default_semantic_models
 
 
 @log