Merge branch 'm-kovalsky/cancel_item_job_instance'

Author: m-kovalsky

src/sempy_labs/__init__.py

@@ -44,6 +44,7 @@
     create_item_schedule_cron,
     create_item_schedule_daily,
     create_item_schedule_weekly,
+    cancel_item_job_instance,
 )
 from ._delta_analyzer import (
     delta_analyzer,
@@ -601,4 +602,5 @@
     "list_domains",
     "get_workspace_git_outbound_policy",
     "set_workspace_git_outbound_policy",
+    "cancel_item_job_instance",
 ]

src/sempy_labs/_job_scheduler.py

@@ -12,6 +12,7 @@
 )
 from uuid import UUID
 import sempy_labs._icons as icons
+import time
 
 
 @log
@@ -457,6 +458,8 @@ def create_item_schedule_weekly(
 
     This is a wrapper function for the following API: `Job Scheduler - Create Item Schedule <https://learn.microsoft.com/rest/api/fabric/core/job-scheduler/create-item-schedule>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     item : str | uuid.UUID
@@ -483,7 +486,7 @@ def create_item_schedule_weekly(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
     (item_name, item_id) = resolve_item_name_and_id(
         item=item, type=type, workspace=workspace
     )
@@ -527,3 +530,80 @@ def create_item_schedule_weekly(
     print(
         f"{icons.green_dot} The schedule for the '{item_name}' {type.lower()} has been created."
     )
+
+
+@log
+def cancel_item_job_instance(
+    item: str | UUID,
+    job_instance_id: UUID,
+    type: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Cancel an item's job instance.
+
+    This is a wrapper function for the following API: `Job Scheduler - Cancel Item Job Instance <https://learn.microsoft.com/rest/api/fabric/core/job-scheduler/cancel-item-job-instance>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The item name or ID.
+    job_instance_id : uuid.UUID
+        The job instance ID to cancel.
+    type : str
+        The item `type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_. If specifying the item name as the item, the item type is required.
+    workspace : str | uuid.UUID, default=None
+        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.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=type, workspace=workspace
+    )
+
+    response = _base_api(
+        request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/instances/{job_instance_id}",
+        client="fabric_sp",
+    )
+    current_status = response.json().get("status")
+
+    if current_status not in ["NotStarted", "InProgress"]:
+        print(
+            f"{icons.info} The job instance '{job_instance_id}' for the '{item_name}' {type.lower()} is in status '{current_status}' and cannot be cancelled."
+        )
+        return
+    else:
+        # Cancel the job instance
+        response = _base_api(
+            request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/instances/{job_instance_id}/cancel",
+            method="post",
+            status_codes=202,
+            client="fabric_sp",
+        )
+
+        status_url = response.headers.get("Location").split("fabric.microsoft.com")[1]
+        status = None
+        while status not in ["Completed", "Failed", "Cancelled"]:
+            response = _base_api(request=status_url)
+            status = response.json().get("status")
+            time.sleep(3)
+
+        if status == "Cancelled":
+            print(
+                f"{icons.green_dot} The job instance '{job_instance_id}' for the '{item_name}' {type.lower()} has been cancelled."
+            )
+            return
+        elif status == "Failed":
+            print(
+                f"{icons.info} The job instance '{job_instance_id}' for the '{item_name}' {type.lower()} could not be cancelled and has failed."
+            )
+            return
+        elif status == "Completed":
+            print(
+                f"{icons.info} The job instance '{job_instance_id}' for the '{item_name}' {type.lower()} has already completed before it could be cancelled."
+            )
+            return

src/sempy_labs/lakehouse/_materialized_lake_views.py

@@ -49,6 +49,7 @@ def refresh_materialized_lake_views(
     df = _base_api(
         request=f"/v1/workspaces/{workspace_id}/lakehouses/{lakehouse_id}/jobs/instances?jobType=RefreshMaterializedLakeViews",
         lro_return_df=True,
+        method="post",
     )
 
     status = df["Status"].iloc[0]