semantic-link-labs 0.9.1__py3-none-any.whl → 0.9.3__py3-none-any.whl

sempy_labs/_connections.py

@@ -1,11 +1,12 @@
 import sempy.fabric as fabric
 import pandas as pd
-from sempy.fabric.exceptions import FabricHTTPException
 from typing import Optional
 from sempy_labs._helper_functions import (
-    pagination,
     _is_valid_uuid,
     resolve_workspace_name_and_id,
+    _update_dataframe_datatypes,
+    _base_api,
+    _create_dataframe,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -18,6 +19,8 @@ def delete_connection(connection: str | UUID):
 
     This is a wrapper function for the following API: `Connections - Delete Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/delete-connection>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     connection : str | uuid.UUID
@@ -25,13 +28,9 @@ def delete_connection(connection: str | UUID):
     """
 
     connection_id = _resolve_connection_id(connection)
-
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/connections/{connection_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(
+        request=f"/v1/connections/{connection_id}", client="fabric_sp", method="delete"
+    )
     print(f"{icons.green_dot} The '{connection}' connection has been deleted.")
 
 
@@ -41,6 +40,8 @@ def delete_connection_role_assignment(connection: str | UUID, role_assignment_id
 
     This is a wrapper function for the following API: `Connections - Delete Connection Role Assignment <https://learn.microsoft.com/rest/api/fabric/core/connections/delete-connection-role-assignment>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     connection : str | uuid.UUID
@@ -50,15 +51,12 @@ def delete_connection_role_assignment(connection: str | UUID, role_assignment_id
     """
 
     connection_id = _resolve_connection_id(connection)
-
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/connections/{connection_id}/roleAssignments/{role_assignment_id}"
+    _base_api(
+        request=f"/v1/connections/{connection_id}/roleAssignments/{role_assignment_id}",
+        client="fabric_sp",
+        method="delete",
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} The '{role_assignment_id}' role assignment Id has been deleted from the '{connection}' connection."
     )
@@ -86,6 +84,8 @@ def list_connection_role_assignments(connection: str | UUID) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Connections - List Connection Role Assignments <https://learn.microsoft.com/rest/api/fabric/core/connections/list-connection-role-assignments>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     connection : str | uuid.UUID
@@ -99,22 +99,20 @@ def list_connection_role_assignments(connection: str | UUID) -> pd.DataFrame:
 
     connection_id = _resolve_connection_id(connection)
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/connections/{connection_id}/roleAssignments")
-
-    df = pd.DataFrame(
-        columns=[
-            "Connection Role Assignment Id",
-            "Principal Id",
-            "Principal Type",
-            "Role",
-        ]
-    )
+    columns = {
+        "Connection Role Assignment Id": "string",
+        "Principal Id": "string",
+        "Principal Type": "string",
+        "Role": "string",
+    }
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    df = _create_dataframe(columns=columns)
 
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/connections/{connection_id}/roleAssignments",
+        client="fabric_sp",
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -134,35 +132,33 @@ def list_connections() -> pd.DataFrame:
     """
     Lists all available connections.
 
+    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
         A pandas dataframe showing all available connections.
     """
 
-    client = fabric.FabricRestClient()
-    response = client.get("/v1/connections")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Connection Id",
-            "Connection Name",
-            "Gateway Id",
-            "Connectivity Type",
-            "Connection Path",
-            "Connection Type",
-            "Privacy Level",
-            "Credential Type",
-            "Single Sign on Type",
-            "Connection Encyrption",
-            "Skip Test Connection",
-        ]
+    columns = {
+        "Connection Id": "string",
+        "Connection Name": "string",
+        "Gateway Id": "string",
+        "Connectivity Type": "string",
+        "Connection Path": "string",
+        "Connection Type": "string",
+        "Privacy Level": "string",
+        "Credential Type": "string",
+        "Single Sign On Type": "string",
+        "Connection Encryption": "string",
+        "Skip Test Connection": "bool",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(
+        request="/v1/connections", client="fabric_sp", uses_pagination=True
     )
+
     for r in responses:
         for i in r.get("value", []):
             connection_details = i.get("connectionDetails", {})
@@ -199,8 +195,8 @@ def list_connections() -> pd.DataFrame:
             }
 
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-    bool_cols = ["Skip Test Connection"]
-    df[bool_cols] = df[bool_cols].astype(bool)
+
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -213,6 +209,8 @@ def list_item_connections(
 
     This is a wrapper function for the following API: `Items - List Item Connections <https://learn.microsoft.com/rest/api/fabric/core/items/list-item-connections>`_.
 
+    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
@@ -236,24 +234,21 @@ def list_item_connections(
         item_name=item_name, type=item_type, workspace=workspace_id
     )
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/items/{item_id}/connections")
-
-    df = pd.DataFrame(
-        columns=[
-            "Connection Name",
-            "Connection Id",
-            "Connectivity Type",
-            "Connection Type",
-            "Connection Path",
-            "Gateway Id",
-        ]
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    columns = {
+        "Connection Name": "string",
+        "Connection Id": "string",
+        "Connectivity Type": "string",
+        "Connection Type": "string",
+        "Connection Path": "string",
+        "Gateway Id": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/items/{item_id}/connections",
+        client="fabric_sp",
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -280,23 +275,17 @@ def _list_supported_connection_types(
         gateway_id = _resolve_gateway_id(gateway)
         url += f"gatewayId={gateway_id}"
 
-    df = pd.DataFrame(
-        columns=[
-            "Connection Type",
-            "Creation Method",
-            "Supported Credential Types",
-            "Supported Connection Encryption Types",
-            "Supports Skip Test Connection",
-        ]
-    )
+    columns = {
+        "Connection Type": "string",
+        "Creation Method": "string",
+        "Supported Credential Types": "string",
+        "Supported Connection Encryption Types": "string",
+        "Supports Skip Test Connection": "bool",
+    }
+    df = _create_dataframe(columns=columns)
 
     url = url.rstrip("&")
-    client = fabric.FabricRestClient()
-    response = client.get(url)
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(request=url, client="fabric_sp", uses_pagination=True)
 
     records = []
     for r in responses:
@@ -318,6 +307,8 @@ def _list_supported_connection_types(
     if records:
         df = pd.DataFrame(records)
 
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
     return df
 
 
@@ -336,6 +327,8 @@ def create_cloud_connection(
 
     This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
 
+    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
@@ -356,7 +349,7 @@ def create_cloud_connection(
         If True, skips the test connection.
     """
 
-    request_body = {
+    payload = {
         "connectivityType": "ShareableCloud",
         "displayName": name,
         "connectionDetails": {
@@ -388,11 +381,13 @@ def create_cloud_connection(
         },
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post("/v1/connections", json=request_body)
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(
+        request="/v1/connections",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        status_codes=201,
+    )
 
     print(f"{icons.green_dot} The '{name}' cloud connection has been created.")
 
@@ -412,6 +407,8 @@ def create_on_prem_connection(
 
     This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
 
+    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
@@ -436,7 +433,7 @@ def create_on_prem_connection(
 
     gateway_id = _resolve_gateway_id(gateway)
 
-    request_body = {
+    payload = {
         "connectivityType": "OnPremisesGateway",
         "gatewayId": gateway_id,
         "displayName": name,
@@ -468,11 +465,13 @@ def create_on_prem_connection(
         },
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post("/v1/connections", json=request_body)
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(
+        request="/v1/connections",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        status_codes=201,
+    )
 
     print(f"{icons.green_dot} The '{name}' on-prem connection has been created.")
 
@@ -493,6 +492,8 @@ def create_vnet_connection(
 
     This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
 
+    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
@@ -517,7 +518,7 @@ def create_vnet_connection(
 
     gateway_id = _resolve_gateway_id(gateway)
 
-    request_body = {
+    payload = {
         "connectivityType": "VirtualNetworkGateway",
         "gatewayId": gateway_id,
         "displayName": name,
@@ -550,11 +551,13 @@ def create_vnet_connection(
         },
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post("/v1/connections", json=request_body)
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(
+        request="/v1/connections",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        status_codes=201,
+    )
 
     print(
         f"{icons.green_dot} The '{name}' virtual network gateway connection has been created."

sempy_labs/_data_pipelines.py

@@ -1,14 +1,14 @@
 import sempy.fabric as fabric
 import pandas as pd
-import sempy_labs._icons as icons
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    lro,
-    pagination,
     _decode_b64,
+    _base_api,
+    _print_success,
+    resolve_item_id,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -31,16 +31,18 @@ def list_data_pipelines(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
         A pandas dataframe showing the data pipelines within a workspace.
     """
 
-    df = pd.DataFrame(columns=["Data Pipeline Name", "Data Pipeline ID", "Description"])
+    columns = {
+        "Data Pipeline Name": "string",
+        "Data Pipeline ID": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/dataPipelines")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/dataPipelines", uses_pagination=True
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -76,24 +78,27 @@ def create_data_pipeline(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"displayName": name}
+    payload = {"displayName": name}
 
     if description:
-        request_body["description"] = description
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/dataPipelines", json=request_body
+        payload["description"] = description
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/dataPipelines",
+        method="post",
+        payload=payload,
+        status_codes=[201, 202],
+        lro_return_status_code=True,
     )
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{name}' data pipeline has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=name,
+        item_type="data pipeline",
+        workspace_name=workspace_name,
+        action="created",
     )
 
 
-def delete_data_pipeline(name: str, workspace: Optional[str | UUID] = None):
+def delete_data_pipeline(name: str | UUID, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric data pipeline.
 
@@ -101,8 +106,8 @@ def delete_data_pipeline(name: str, workspace: Optional[str | UUID] = None):
 
     Parameters
     ----------
-    name: str
-        Name of the data pipeline.
+    name: str | uuid.UUID
+        Name or ID of the data pipeline.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -110,32 +115,27 @@ def delete_data_pipeline(name: str, workspace: Optional[str | UUID] = None):
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=name, type="DataPipeline", workspace=workspace_id
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/workspaces/{workspace_id}/dataPipelines/{item_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{name}' data pipeline within the '{workspace_name}' workspace has been deleted."
+    item_id = resolve_item_id(item=name, type="DataPipeline", workspace=workspace)
+
+    fabric.delete_item(item_id=item_id, workspace=workspace)
+    _print_success(
+        item_name=name,
+        item_type="data pipeline",
+        workspace_name=workspace_name,
+        action="deleted",
     )
 
 
 def get_data_pipeline_definition(
-    name: str, workspace: Optional[str | UUID] = None, decode: bool = True
+    name: str | UUID, workspace: Optional[str | UUID] = None, decode: bool = True
 ) -> dict | pd.DataFrame:
     """
     Obtains the definition of a data pipeline.
 
     Parameters
     ----------
-    name : str
-        The name of the data pipeline.
+    name : str or uuid.UUID
+        The name or ID of the data pipeline.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -152,16 +152,14 @@ def get_data_pipeline_definition(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = fabric.resolve_item_id(
-        item_name=name, type="DataPipeline", workspace=workspace_id
-    )
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/dataPipelines/{item_id}/getDefinition"
+    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,
     )
-    result = lro(client, response).json()
-
     df = pd.json_normalize(result["definition"]["parts"])
 
     if not decode: