fabric_sp

Author: m-kovalsky

src/sempy_labs/_data_pipelines.py

@@ -2,6 +2,7 @@
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
+    resolve_workspace_id,
     _decode_b64,
     _base_api,
     resolve_item_id,
@@ -20,6 +21,8 @@ def list_data_pipelines(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Data Pipelines <https://learn.microsoft.com/rest/api/fabric/datapipeline/items/list-data-pipelines>`_.
 
+    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
@@ -40,20 +43,26 @@ def list_data_pipelines(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     }
     df = _create_dataframe(columns=columns)
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/dataPipelines", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/dataPipelines",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Data Pipeline Name": v.get("displayName"),
-                "Data Pipeline ID": v.get("id"),
-                "Description": v.get("description"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            rows.append(
+                {
+                    "Data Pipeline Name": v.get("displayName"),
+                    "Data Pipeline ID": v.get("id"),
+                    "Description": v.get("description"),
+                }
+            )
+    if rows:
+        df = pd.DataFrame(rows, columns=columns.keys())
 
     return df
 
@@ -67,6 +76,8 @@ def create_data_pipeline(
 
     This is a wrapper function for the following API: `Items - Create Data Pipeline <https://learn.microsoft.com/rest/api/fabric/datapipeline/items/create-data-pipeline>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     name: str
@@ -91,6 +102,8 @@ def delete_data_pipeline(name: str | UUID, workspace: Optional[str | UUID] = Non
 
     This is a wrapper function for the following API: `Items - Delete Data Pipeline <https://learn.microsoft.com/rest/api/fabric/datapipeline/items/delete-data-pipeline>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     name: str | uuid.UUID
@@ -130,14 +143,15 @@ def get_data_pipeline_definition(
         A pandas dataframe showing the data pipelines within a workspace.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
 
     item_id = resolve_item_id(item=name, type="DataPipeline", workspace=workspace)
     result = _base_api(
         request=f"/v1/workspaces/{workspace_id}/dataPipelines/{item_id}/getDefinition",
         method="post",
         lro_return_json=True,
         status_codes=None,
+        client="fabric_sp",
     )
     df = pd.json_normalize(result["definition"]["parts"])
 

src/sempy_labs/_dataflows.py

@@ -333,7 +333,6 @@ def get_dataflow_definition(
         result = _base_api(
             request=f"/v1.0/myorg/groups/{workspace_id}/dataflows/{dataflow_id}",
             client="fabric_sp",
-            method="get",
         ).json()
 
         return result

src/sempy_labs/_deployment_pipelines.py

@@ -17,6 +17,8 @@ def list_deployment_pipelines() -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Deployment Pipelines - List Deployment Pipelines <https://learn.microsoft.com/rest/api/fabric/core/deployment-pipelines/list-deployment-pipelines>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Returns
     -------
     pandas.DataFrame
@@ -34,16 +36,22 @@ def list_deployment_pipelines() -> pd.DataFrame:
         request="/v1/deploymentPipelines",
         status_codes=200,
         uses_pagination=True,
+        client="fabric_sp",
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Deployment Pipeline Id": v.get("id"),
-                "Deployment Pipeline Name": v.get("displayName"),
-                "Description": v.get("description"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            rows.append(
+                {
+                    "Deployment Pipeline Id": v.get("id"),
+                    "Deployment Pipeline Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=columns.keys())
 
     return df
 
@@ -55,6 +63,8 @@ def list_deployment_pipeline_stages(deployment_pipeline: str | UUID) -> pd.DataF
 
     This is a wrapper function for the following API: `Deployment Pipelines - List Deployment Pipeline Stages <https://learn.microsoft.com/rest/api/fabric/core/deployment-pipelines/list-deployment-pipeline-stages>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     deployment_pipeline : str | uuid.UUID
@@ -87,22 +97,26 @@ def list_deployment_pipeline_stages(deployment_pipeline: str | UUID) -> pd.DataF
         request=f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages",
         status_codes=200,
         uses_pagination=True,
+        client="fabric_sp",
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Deployment Pipeline Stage Id": v.get("id"),
-                "Deployment Pipeline Stage Name": v.get("displayName"),
-                "Description": v.get("description"),
-                "Order": v.get("order"),
-                "Workspace Id": v.get("workspaceId"),
-                "Workspace Name": v.get("workspaceName"),
-                "Public": v.get("isPublic"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+            rows.append(
+                {
+                    "Deployment Pipeline Stage Id": v.get("id"),
+                    "Deployment Pipeline Stage Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                    "Order": v.get("order"),
+                    "Workspace Id": v.get("workspaceId"),
+                    "Workspace Name": v.get("workspaceName"),
+                    "Public": v.get("isPublic"),
+                }
+            )
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(df, columns)
 
     return df
 
@@ -117,6 +131,8 @@ def list_deployment_pipeline_stage_items(
 
     This is a wrapper function for the following API: `Deployment Pipelines - List Deployment Pipeline Stage Items <https://learn.microsoft.com/rest/api/fabric/core/deployment-pipelines/list-deployment-pipeline-stage-items>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     deployment_pipeline : str | uuid.UUID
@@ -170,18 +186,24 @@ def resolve_deployment_pipeline_stage_id(
         request=f"/v1/deploymentPipelines/{deployment_pipeline_id}/stages/{stage_id}/items",
         status_codes=200,
         uses_pagination=True,
+        client="fabric_sp",
     )
 
+    rows = []
     for r in responses:
         for v in r.get("value", []):
-            new_data = {
-                "Deployment Pipeline Stage Item Id": v.get("itemId"),
-                "Deployment Pipeline Stage Item Name": v.get("itemDisplayName"),
-                "Item Type": v.get("itemType"),
-                "Source Item Id": v.get("sourceItemId"),
-                "Target Item Id": v.get("targetItemId"),
-                "Last Deployment Time": v.get("lastDeploymentTime"),
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            rows.append(
+                {
+                    "Deployment Pipeline Stage Item Id": v.get("itemId"),
+                    "Deployment Pipeline Stage Item Name": v.get("itemDisplayName"),
+                    "Item Type": v.get("itemType"),
+                    "Source Item Id": v.get("sourceItemId"),
+                    "Target Item Id": v.get("targetItemId"),
+                    "Last Deployment Time": v.get("lastDeploymentTime"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df

src/sempy_labs/_eventstreams.py

@@ -19,6 +19,8 @@ def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Eventstreams <https://learn.microsoft.com/rest/api/fabric/environment/items/list-eventstreams>`_.
 
+    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
@@ -41,7 +43,9 @@ def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     workspace_id = resolve_workspace_id(workspace)
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventstreams", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/eventstreams",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     rows = []
@@ -70,6 +74,8 @@ def create_eventstream(
 
     This is a wrapper function for the following API: `Items - Create Eventstream <https://learn.microsoft.com/rest/api/fabric/environment/items/create-eventstream>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     name: str
@@ -96,6 +102,8 @@ def delete_eventstream(
 
     This is a wrapper function for the following API: `Items - Delete Eventstream <https://learn.microsoft.com/rest/api/fabric/environment/items/delete-eventstream>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     eventstream: str | uuid.UUID

src/sempy_labs/_job_scheduler.py

@@ -114,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", []):
@@ -198,7 +198,8 @@ def list_item_schedules(
     }
 
     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 = []
@@ -292,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.")
@@ -359,6 +361,7 @@ def create_item_schedule_cron(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -428,6 +431,7 @@ def create_item_schedule_daily(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -517,6 +521,7 @@ def create_item_schedule_weekly(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(