semantic-link-labs 0.12.0__py3-none-any.whl → 0.12.2__py3-none-any.whl

sempy_labs/_job_scheduler.py

@@ -8,6 +8,7 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_id,
+    resolve_item_id,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -113,7 +114,7 @@ def _get_item_job_instance(url: str) -> pd.DataFrame:
     }
     df = _create_dataframe(columns=columns)
 
-    response = _base_api(request=url)
+    response = _base_api(request=url, client="fabric_sp")
 
     rows = []
     for v in response.json().get("value", []):
@@ -171,11 +172,9 @@ def list_item_schedules(
     """
 
     workspace_id = resolve_workspace_id(workspace)
-    (item_name, item_id) = resolve_item_name_and_id(
-        item=item, type=type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item, type=type, workspace=workspace_id)
 
-    columns = {
+    base_columns = {
         "Job Schedule Id": "string",
         "Enabled": "bool",
         "Created Date Time": "datetime",
@@ -183,48 +182,75 @@ def list_item_schedules(
         "End Date Time": "string",
         "Local Time Zone Id": "string",
         "Type": "string",
-        "Interval": "string",
-        "Weekdays": "string",
-        "Times": "string",
         "Owner Id": "string",
         "Owner Type": "string",
-        "Recurrence": "int",
+    }
+
+    optional_columns = {
+        "Occurrence Day of Month": "int_fillna",
+        "Occurrence Week Index": "string",
+        "Occurrence Weekday": "string",
         "Occurrence Type": "string",
-        "Occurrence Day of Month": "int",
+        "Interval": "int_fillna",
+        "Times": "string",
+        "Recurrence": "int_fillna",
+        "Weekdays": "string",
     }
-    df = _create_dataframe(columns=columns)
 
     response = _base_api(
-        request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/{job_type}/schedules"
+        request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/{job_type}/schedules",
+        client="fabric_sp",
     )
 
     rows = []
     for v in response.json().get("value", []):
         config = v.get("configuration", {})
         own = v.get("owner", {})
-        rows.append(
-            {
-                "Job Schedule Id": v.get("id"),
-                "Enabled": v.get("enabled"),
-                "Created Date Time": v.get("createdDateTime"),
-                "Start Date Time": config.get("startDateTime"),
-                "End Date Time": config.get("endDateTime"),
-                "Local Time Zone Id": config.get("localTimeZoneId"),
-                "Type": config.get("type"),
-                "Interval": config.get("interval"),
-                "Weekdays": config.get("weekdays"),
-                "Times": config.get("times"),
-                "Owner Id": own.get("id"),
-                "Owner Type": own.get("type"),
-                "Recurrence": config.get("recurrence"),
-                "Occurrence Type": config.get("occurence", {}).get("occurrenceType"),
-                "Occurrence Day of Month": config.get("occurrence", {}).get(
-                    "dayOfMonth"
-                ),
-            }
-        )
+        occurrence = config.get("occurrence", {})
+        type = config.get("type")
+
+        row = {
+            "Job Schedule Id": v.get("id"),
+            "Enabled": v.get("enabled"),
+            "Created Date Time": v.get("createdDateTime"),
+            "Start Date Time": config.get("startDateTime"),
+            "End Date Time": config.get("endDateTime"),
+            "Local Time Zone Id": config.get("localTimeZoneId"),
+            "Type": type,
+            "Owner Id": own.get("id"),
+            "Owner Type": own.get("type"),
+        }
+
+        if type == "Cron":
+            row["Interval"] = config.get("interval")
+        elif type == "Daily":
+            row["Times"] = config.get("times")
+        elif type == "Weekly":
+            row["Times"] = config.get("times")
+            row["Weekdays"] = config.get("weekdays")
+        elif type == "Monthly":
+            occurrence_type = occurrence.get("occurrenceType")
+            row["Times"] = config.get("times")
+            row["Recurrence"] = config.get("recurrence")
+            row["Occurrence Type"] = occurrence_type
+
+            if occurrence_type == "OrdinalWeekday":
+                row["Occurrence Week Index"] = occurrence.get("weekIndex")
+                row["Occurrence Weekday"] = occurrence.get("weekday")
+            elif occurrence_type == "DayOfMonth":
+                row["Occurrence Day of Month"] = occurrence.get("dayOfMonth")
+
+        rows.append(row)
+
+    # Build final column map based on what was actually present
+    columns = base_columns.copy()
 
     if rows:
+        # Find which optional columns were actually included in rows
+        all_used_columns = set().union(*(r.keys() for r in rows))
+        for col in all_used_columns:
+            if col in optional_columns:
+                columns[col] = optional_columns[col]
         df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
@@ -267,6 +293,7 @@ def run_on_demand_item_job(
         method="post",
         lro_return_status_code=True,
         status_codes=202,
+        client="fabric_sp",
     )
 
     print(f"{icons.green_dot} The '{item_name}' {type.lower()} has been executed.")
@@ -334,6 +361,7 @@ def create_item_schedule_cron(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -403,6 +431,7 @@ def create_item_schedule_daily(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -492,6 +521,7 @@ def create_item_schedule_weekly(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(

sempy_labs/_labels.py

@@ -5,6 +5,9 @@ from typing import Optional, Union
 from uuid import UUID
 from sempy.fabric.exceptions import FabricHTTPException
 from sempy._utils._log import log
+from sempy_labs._helper_functions import (
+    _get_url_prefix,
+)
 
 
 @log
@@ -87,12 +90,7 @@ def list_item_labels(workspace: Optional[Union[str, UUID]] = None) -> pd.DataFra
     if artifact_ids:
         payload["artifacts"] = [{"artifactId": i} for i in artifact_ids]
 
-    client = fabric.PowerBIRestClient()
-    response = client.get("/v1.0/myorg/capacities")
-    if response.status_code != 200:
-        raise FabricHTTPException("Failed to retrieve URL prefix.")
-    context = response.json().get("@odata.context")
-    prefix = context.split("/v1.0")[0]
+    prefix = _get_url_prefix()
 
     response = requests.post(
         f"{prefix}/metadata/informationProtection/artifacts",

sempy_labs/_model_dependencies.py

@@ -334,7 +334,10 @@ def measure_dependency_tree(
 
     # Visualize the tree structure using RenderTree
     for pre, _, node in RenderTree(node_dict[measure_name]):
-        if icons.table_icon in node.custom_property:
+        if (
+            hasattr(node, "custom_property")
+            and icons.table_icon in node.custom_property
+        ):
             print(f"{pre}{node.custom_property}'{node.name}'")
         else:
-            print(f"{pre}{node.custom_property}[{node.name}]")
+            print(f"{pre}'{node.name}'")

sempy_labs/_warehouses.py

@@ -1,4 +1,5 @@
 from ._helper_functions import (
+    resolve_item_id,
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
@@ -232,3 +233,57 @@ def get_warehouse_columns(
         )
 
     return df
+
+
+@log
+def get_warehouse_connection_string(
+    warehouse: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    guest_tenant_id: Optional[UUID] = None,
+    private_link_type: Optional[str] = None,
+) -> str:
+    """
+    Returns the SQL connection string of the specified warehouse.
+
+    Parameters
+    ----------
+    warehouse : str | uuid.UUID
+        Name or ID of the Fabric warehouse.
+    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.
+    guest_tenant_id : uuid.UUID, default=None
+        The guest tenant ID if the end user's tenant is different from the warehouse tenant.
+    private_link_type : str, default=None
+        Indicates the type of private link this connection string uses. Must be either 'Workspace' or 'None' or left as None.
+
+    Returns
+    -------
+    str
+        Returns the SQL connection string of the specified warehouse.
+    """
+    workspace_id = resolve_workspace_id(workspace)
+    warehouse_id = resolve_item_id(
+        item=warehouse, type="Warehouse", workspace=workspace
+    )
+
+    url = f"/v1/workspaces/{workspace_id}/warehouses/{warehouse_id}/connectionString"
+
+    if private_link_type is not None and private_link_type not in ["Workspace", "None"]:
+        raise ValueError(
+            f"{icons.red_dot} private_link_type must be 'Workspace' or 'None' or left as None."
+        )
+
+    if guest_tenant_id or private_link_type:
+        params = []
+        if guest_tenant_id:
+            params.append(f"guestTenantId={guest_tenant_id}")
+        if private_link_type:
+            params.append(f"privateLinkType={private_link_type}")
+        param_str = "?" + "&".join(params)
+        url += param_str
+
+    response = _base_api(request=url, client="fabric_sp")
+
+    return response.json().get("connectionString")

sempy_labs/admin/__init__.py

@@ -94,6 +94,10 @@ from ._tenant_keys import (
     list_tenant_keys,
     rotate_tenant_key,
 )
+from ._sharing_links import (
+    remove_all_sharing_links,
+    remove_sharing_links,
+)
 
 __all__ = [
     "list_items",
@@ -155,4 +159,6 @@ __all__ = [
     "delete_tag",
     "list_tenant_keys",
     "rotate_tenant_key",
+    "remove_all_sharing_links",
+    "remove_sharing_links",
 ]

sempy_labs/admin/_capacities.py

@@ -285,16 +285,16 @@ def list_capacities(
                 "Users": i.get("users", []),
             }
 
-        if include_tenant_key:
-            tenant_key = i.get("tenantKey") or {}
-            row.update(
-                {
-                    "Tenant Key Id": tenant_key.get("id"),
-                    "Tenant Key Name": tenant_key.get("name"),
-                }
-            )
-
-        rows.append(row)
+            if include_tenant_key:
+                tenant_key = i.get("tenantKey") or {}
+                row.update(
+                    {
+                        "Tenant Key Id": tenant_key.get("id"),
+                        "Tenant Key Name": tenant_key.get("name"),
+                    }
+                )
+
+            rows.append(row)
 
     if rows:
         df = pd.DataFrame(rows, columns=list(columns.keys()))

sempy_labs/admin/_sharing_links.py

@@ -0,0 +1,110 @@
+from sempy._utils._log import log
+from sempy_labs._helper_functions import (
+    _base_api,
+    _is_valid_uuid,
+)
+import sempy_labs._icons as icons
+from typing import List
+
+
+@log
+def remove_all_sharing_links(sharing_link_type: str = "OrgLink"):
+    """
+    Deletes all organization sharing links for all Fabric items in the tenant. This action cannot be undone.
+
+    This is a wrapper function for the following API: `Sharing Links - Remove All Sharing Links <https://learn.microsoft.com/rest/api/fabric/admin/sharing-links/remove-all-sharing-links>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    sharing_link_type : str, default='OrgLink'
+        Specifies the type of sharing link that is required to be deleted. Additional sharing link types may be added over time.
+    """
+
+    payload = {"sharingLinkType": sharing_link_type}
+
+    _base_api(
+        request="/v1/admin/items/removeAllSharingLinks",
+        client="fabric_sp",
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} All organization sharing links for all Fbric items in the tenant have been deleted."
+    )
+
+
+@log
+def remove_sharing_links(items: List[dict], sharing_link_type: str = "OrgLink"):
+    """
+    Deletes all organization sharing links for the specified Fabric items. This action cannot be undone.
+
+    This is a wrapper function for the following API: `Sharing Links - Bulk Remove Sharing Links <https://learn.microsoft.com/rest/api/fabric/admin/sharing-links/bulk-remove-sharing-links>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    items : List[dict]
+        A list of dictionaries, each representing an item. The 'item' and 'workspace' accepts either name or ID. Examples:
+
+        [
+            {
+                "item": "MyReport",
+                "type": "Report",
+                "workspace": "Workpsace 1",
+            },
+            {
+                "item": "MyReport2",
+                "type": "Report",
+                "workspace": "Workspace 2",
+            },
+        ]
+
+        [
+            {
+                "item": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
+                "type": "Report",
+                "workspace": "Workspace 1",
+            },
+            {
+                "item": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
+                "type": "Notebook",
+                "workspace": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
+            },
+        ]
+
+    sharing_link_type : str, default='OrgLink'
+        Specifies the type of sharing link that is required to be deleted. Additional sharing link types may be added over time.
+    """
+
+    from sempy_labs.admin._items import _resolve_item_id
+
+    payload = {"items": [], "sharingLinkType": sharing_link_type}
+
+    for i in items:
+        item = i.get("item")
+        type = i.get("type")
+        workspace = i.get("workspace")
+        if _is_valid_uuid(item):
+            payload["items"].append({"id": item, "type": type})
+        else:
+            item_id = _resolve_item_id(item=item, type=type, workspace=workspace)
+            payload["items"].append({"id": item_id, "type": type})
+
+    _base_api(
+        request="/v1/admin/items/bulkRemoveSharingLinks",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+    )
+
+    print(
+        f"{icons.green_dot} Organizational sharing links for all specified items have been deleted."
+    )

sempy_labs/graph/__init__.py

@@ -6,12 +6,18 @@ from ._groups import (
     add_group_owners,
     resolve_group_id,
     renew_group,
+    create_group,
+    delete_group,
+    update_group,
 )
 from ._users import (
     resolve_user_id,
     get_user,
     list_users,
     send_mail,
+    create_user,
+    delete_user,
+    update_user,
 )
 from ._teams import (
     list_teams,
@@ -30,4 +36,10 @@ __all__ = [
     "list_users",
     "send_mail",
     "list_teams",
+    "create_user",
+    "create_group",
+    "delete_user",
+    "delete_group",
+    "update_user",
+    "update_group",
 ]

sempy_labs/graph/_groups.py

@@ -1,6 +1,6 @@
 import pandas as pd
 from uuid import UUID
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
     _base_api,
     _create_dataframe,
@@ -8,7 +8,7 @@ from .._helper_functions import (
 )
 from sempy._utils._log import log
 import sempy_labs._icons as icons
-from typing import List, Literal
+from typing import List, Literal, Optional
 
 
 @log
@@ -424,3 +424,158 @@ def renew_group(group: str | UUID):
     )
 
     print(f"{icons.green_dot} The '{group}' group has been renewed.")
+
+
+@log
+def create_group(
+    display_name: str,
+    description: Optional[str] = None,
+    mail_enabled: bool = False,
+    security_enabled: bool = True,
+    mail_nickname: str = None,
+    owners: Optional[str | UUID | List[str | UUID]] = None,
+    members: Optional[str | UUID | List[str | UUID]] = None,
+):
+    """
+    Creates a new group.
+
+    This is a wrapper function for the following API: `Create group <https://learn.microsoft.com/graph/api/group-post-groups>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    display_name : str
+        The name of the group.
+    description : str, optional
+        The description of the group.
+    mail_enabled : bool, default=False
+        Whether the group is mail-enabled.
+    security_enabled : bool, default=True
+        Whether the group is security-enabled.
+    mail_nickname : str, default=None
+        The mail alias for the group.
+    owners : str | uuid.UUID | List[str | uuid.UUID], default=None
+        The owners of the group.
+    members : str | uuid.UUID | List[str | uuid.UUID], default=None
+        The members of the group.
+    """
+    from sempy_labs.graph._users import resolve_user_id
+
+    payload = {
+        "displayName": display_name,
+        "description": description,
+        "mailEnabled": mail_enabled,
+        "securityEnabled": security_enabled,
+        "mailNickname": mail_nickname,
+    }
+
+    if owners:
+        if isinstance(owners, str):
+            owners = [owners]
+        user_list = []
+        for o in owners:
+            user_id = resolve_user_id(o)
+            user_list.append(f"https://graph.microsoft.com/v1.0/users/{user_id}")
+        payload["owners@odata.bind"] = user_list
+    if members:
+        if isinstance(members, str):
+            members = [members]
+        user_list = []
+        for m in members:
+            user_id = resolve_user_id(m)
+            user_list.append(f"https://graph.microsoft.com/v1.0/users/{user_id}")
+        payload["members@odata.bind"] = user_list
+
+    _base_api(
+        request="groups",
+        client="graph",
+        payload=payload,
+        method="post",
+        status_codes=201,
+    )
+
+    print(f"{icons.green_dot} The '{display_name}' group has been created.")
+
+
+@log
+def delete_group(group: str | UUID):
+    """
+    Deletes a group.
+
+    This is a wrapper function for the following API: `Delete group <https://learn.microsoft.com/graph/api/group-delete>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    group : str | uuid.UUID
+        The group name or ID.
+    """
+
+    group_id = resolve_group_id(group)
+
+    _base_api(
+        request=f"groups/{group_id}",
+        client="graph",
+        status_codes=204,
+        method="delete",
+    )
+
+    print(f"{icons.green_dot} The '{group}' group has been deleted successfully.")
+
+
+@log
+def update_group(
+    group: str | UUID,
+    display_name: Optional[str] = None,
+    mail_nickname: Optional[str] = None,
+    description: Optional[str] = None,
+    security_enabled: Optional[bool] = None,
+):
+    """
+    Updates a group's properties.
+
+    This is a wrapper function for the following API: `Update group <https://learn.microsoft.com/en-us/graph/api/group-update>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    group : str | uuid.UUID
+        The group name or ID.
+    display_name : str, default=None
+        The new display name for the group.
+    mail_nickname : str, default=None
+        The new mail nickname for the group.
+    description : str, default=None
+        The new description for the group.
+    security_enabled : bool, default=None
+        Whether the group is security-enabled.
+    """
+
+    group_id = resolve_group_id(group)
+
+    payload = {}
+    if display_name:
+        payload["displayName"] = display_name
+    if mail_nickname:
+        payload["mailNickname"] = mail_nickname
+    if description:
+        payload["description"] = description
+    if security_enabled is not None and isinstance(security_enabled, bool):
+        payload["securityEnabled"] = security_enabled
+
+    if not payload:
+        print(f"{icons.info} No properties to update.")
+        return
+
+    _base_api(
+        request=f"groups/{group_id}",
+        client="graph",
+        status_codes=204,
+        payload=payload,
+        method="patch",
+    )
+
+    print(f"{icons.green_dot} The '{group}' group has been updated successfully.")