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

sempy_labs/_gateways.py

@@ -1,14 +1,14 @@
-import sempy.fabric as fabric
 from sempy._utils._log import log
 import pandas as pd
 from typing import Optional
-from sempy.fabric.exceptions import FabricHTTPException
 from sempy_labs._helper_functions import (
-    pagination,
     _is_valid_uuid,
     resolve_capacity_id,
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
+    _update_dataframe_datatypes,
+    _base_api,
+    _create_dataframe,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -21,33 +21,30 @@ def list_gateways() -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Gateways - List Gateways <https://learn.microsoft.com/rest/api/fabric/core/gateways/list-gateways>`_.
 
+    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 a list of all gateways the user has permission for, including on-premises, on-premises (personal mode), and virtual network gateways.
     """
 
-    client = fabric.FabricRestClient()
-    response = client.get("/v1/gateways")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Gateway Name",
-            "Gateway Id",
-            "Type",
-            "Public Key Exponent",
-            "Public Key Modulus",
-            "Version",
-            "Number Of Member Gateways",
-            "Load Balancing Setting",
-            "Allow Cloud Connection Refresh",
-            "Allow Custom Connectors",
-        ]
+    columns = {
+        "Gateway Name": "string",
+        "Gateway Id": "string",
+        "Type": "string",
+        "Public Key Exponent": "string",
+        "Public Key Modulus": "string",
+        "Version": "string",
+        "Number Of Member Gateways": "int",
+        "Load Balancing Setting": "string",
+        "Allow Cloud Connection Refresh": "bool",
+        "Allow Custom Connectors": "bool",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(
+        request="/v1/gateways", client="fabric_sp", uses_pagination=True
     )
 
     for r in responses:
@@ -67,10 +64,7 @@ def list_gateways() -> pd.DataFrame:
 
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    int_cols = ["Number Of Member Gateways"]
-    bool_cols = ["Allow Cloud Connection Refresh", "Allow Custom Connectors"]
-    df[bool_cols] = df[bool_cols].astype(bool)
-    df[int_cols] = df[int_cols].astype(int)
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -95,6 +89,8 @@ def delete_gateway(gateway: str | UUID):
 
     This is a wrapper function for the following API: `Gateways - Delete Gateway <https://learn.microsoft.com/rest/api/fabric/core/gateways/delete-gateway>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     gateway : str | uuid.UUID
@@ -102,12 +98,7 @@ def delete_gateway(gateway: str | UUID):
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/gateways/{gateway_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(request=f"/v1/gateways/{gateway_id}", client="fabric_sp", method="delete")
     print(f"{icons.green_dot} The '{gateway}' gateway has been deleted.")
 
 
@@ -117,6 +108,8 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Gateways - List Gateway Role Assignments <https://learn.microsoft.com/rest/api/fabric/core/gateways/list-gateway-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
     ----------
     gateway : str | uuid.UUID
@@ -128,16 +121,19 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
         A pandas dataframe showing a list of gateway role assignments.
     """
 
+    columns = {
+        "Gateway Role Assignment Id": "string",
+        "Principal Id": "string",
+        "Principal Type": "string",
+        "Role": "string",
+    }
+    df = _create_dataframe(columns=columns)
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/gateways/{gateway_id}/roleAssignments")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    df = pd.DataFrame(columns=[])
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/gateways/{gateway_id}/roleAssignments",
+        client="fabric_sp",
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -153,31 +149,31 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
     return df
 
 
-def delete_gateway_role_assignment(gateway: str | UUID, role_assignement_id: UUID):
+def delete_gateway_role_assignment(gateway: str | UUID, role_assignment_id: UUID):
     """
     Delete the specified role assignment for the gateway.
 
     This is a wrapper function for the following API: `Gateways - Delete Gateway Role Assignment <https://learn.microsoft.com/rest/api/fabric/core/gateways/delete-gateway-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
     ----------
     gateway : str | uuid.UUID
         The gateway name or ID.
-    role_assignement_id : uuid.UUID
+    role_assignment_id : uuid.UUID
         The role assignment ID.
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/gateways/{gateway_id}/roleAssignments/{role_assignement_id}"
+    _base_api(
+        request=f"/v1/gateways/{gateway_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_assignement_id}' role assignment for the '{gateway}' gateway has been deleted."
+        f"{icons.green_dot} The '{role_assignment_id}' role assignment for the '{gateway}' gateway has been deleted."
     )
 
 
@@ -204,6 +200,8 @@ def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
 
     This is a wrapper function for the following API: `Gateways - Delete Gateway Member <https://learn.microsoft.com/rest/api/fabric/core/gateways/delete-gateway-member>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     gateway : str | uuid.UUID
@@ -217,12 +215,11 @@ def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
         gateway=gateway_id, gateway_member=gateway_member
     )
 
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/gateways/{gateway_id}/members/{member_id}")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(
+        request=f"/v1/gateways/{gateway_id}/members/{member_id}",
+        client="fabric_sp",
+        method="delete",
+    )
     print(
         f"{icons.green_dot} The '{member_id}' member for the '{gateway}' gateway has been deleted."
     )
@@ -234,6 +231,8 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Gateways - List Gateway Members <https://learn.microsoft.com/rest/api/fabric/core/gateways/list-gateway-members>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     gateway : str | uuid.UUID
@@ -246,21 +245,19 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
     """
 
     gateway_id = _resolve_gateway_id(gateway)
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/gateways/{gateway_id}/members")
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Member Id",
-            "Member Name",
-            "Public Key Exponent",
-            "Public Key Modulus",
-            "Version",
-            "Enabled",
-        ]
+
+    columns = {
+        "Member Id": "string",
+        "Member Name": "string",
+        "Public Key Exponent": "string",
+        "Public Key Modulus": "string",
+        "Version": "string",
+        "Enabled": "bool",
+    }
+    df = _create_dataframe(columns=columns)
+
+    response = _base_api(
+        request=f"/v1/gateways/{gateway_id}/members", client="fabric_sp"
     )
 
     for v in response.json().get("value", []):
@@ -275,8 +272,7 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
 
         df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    bool_cols = ["Enabled"]
-    df[bool_cols] = df[bool_cols].astype(bool)
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -296,6 +292,8 @@ def create_vnet_gateway(
 
     This is a wrapper function for the following API: `Gateways - Create Gateway <https://learn.microsoft.com/rest/api/fabric/core/gateways/create-gateway>`_.
 
+    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
@@ -316,8 +314,6 @@ def create_vnet_gateway(
         The name of the subnet.
     """
 
-    client = fabric.FabricRestClient()
-
     capacity_id = resolve_capacity_id(capacity)
     payload = {
         "type": "VirtualNetwork",
@@ -332,10 +328,14 @@ def create_vnet_gateway(
         "inactivityMinutesBeforeSleep": inactivity_minutes_before_sleep,
         "numberOfMemberGateways": number_of_member_gateways,
     }
-    response = client.post("/v1/gateways", json=payload)
 
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(
+        request="/v1/gateways",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        status_codes=201,
+    )
 
     print(
         f"{icons.green_dot} The '{name}' gateway was created within the '{capacity}' capacity."
@@ -353,6 +353,8 @@ def update_on_premises_gateway(
 
     This is a wrapper function for the following API: `Gateways - Update Gateway <https://learn.microsoft.com/rest/api/fabric/core/gateways/update-gateway>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     gateway : str | uuid.UUID
@@ -383,11 +385,12 @@ def update_on_premises_gateway(
 
     payload["type"] = "OnPremises"
 
-    client = fabric.FabricRestClient()
-    response = client.patch(f"/v1/gateways/{gateway_id}", json=payload)
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    _base_api(
+        request=f"/v1/gateways/{gateway_id}",
+        client="fabric_sp",
+        method="patch",
+        payload=payload,
+    )
 
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
@@ -403,6 +406,8 @@ def update_vnet_gateway(
 
     This is a wrapper function for the following API: `Gateways - Update Gateway <https://learn.microsoft.com/rest/api/fabric/core/gateways/update-gateway>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     gateway : str | uuid.UUID
@@ -434,12 +439,12 @@ def update_vnet_gateway(
 
     payload["type"] = "VirtualNetwork"
 
-    client = fabric.FabricRestClient()
-    response = client.patch(f"/v1/gateways/{gateway_id}", json=payload)
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
+    _base_api(
+        request=f"/v1/gateways/{gateway_id}",
+        client="fabric_sp",
+        method="patch",
+        payload=payload,
+    )
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
 
 
@@ -451,6 +456,8 @@ def bind_semantic_model_to_gateway(
 
     This is a wrapper function for the following API: `Datasets - Bind To Gateway In Group <https://learn.microsoft.com/rest/api/power-bi/datasets/bind-to-gateway-in-group>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     dataset : str | uuid.UUID
@@ -473,15 +480,12 @@ def bind_semantic_model_to_gateway(
         "gatewayObjectId": gateway_id,
     }
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",
-        json=payload,
+    _base_api(
+        request=f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
     )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} The '{dataset_name}' semantic model within the '{workspace_name}' workspace has been binded to the '{gateway_id}' gateway."
     )

sempy_labs/_generate_semantic_model.py

@@ -10,7 +10,7 @@ from sempy_labs._helper_functions import (
     resolve_dataset_name_and_id,
     _conv_b64,
     _decode_b64,
-    lro,
+    _base_api,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
@@ -145,18 +145,16 @@ def create_semantic_model_from_bim(
     dfI = fabric.list_datasets(workspace=workspace_id, mode="rest")
     dfI_filt = dfI[(dfI["Dataset Name"] == dataset)]
 
-    if len(dfI_filt) > 0:
+    if not dfI_filt.empty:
         raise ValueError(
             f"{icons.red_dot} The '{dataset}' semantic model already exists as a semantic model in the '{workspace_name}' workspace."
         )
 
-    client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
-
     payloadPBIDefinition = _conv_b64(defPBIDataset)
     payloadBim = _conv_b64(bim_file)
 
-    request_body = {
+    payload = {
         "displayName": dataset,
         "definition": {
             "parts": [
@@ -174,13 +172,14 @@ def create_semantic_model_from_bim(
         },
     }
 
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels",
-        json=request_body,
+    _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels",
+        payload=payload,
+        method="post",
+        lro_return_status_code=True,
+        status_codes=[201, 202],
     )
 
-    lro(client, response, status_codes=[201, 202])
-
     print(
         f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace_name}' workspace."
     )
@@ -210,13 +209,11 @@ def update_semantic_model_from_bim(
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
-    client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
-
     payloadPBIDefinition = _conv_b64(defPBIDataset)
     payloadBim = _conv_b64(bim_file)
 
-    request_body = {
+    payload = {
         "displayName": dataset_name,
         "definition": {
             "parts": [
@@ -234,13 +231,14 @@ def update_semantic_model_from_bim(
         },
     }
 
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/updateDefinition",
-        json=request_body,
+    _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/updateDefinition",
+        payload=payload,
+        method="post",
+        lro_return_status_code=True,
+        status_codes=None,
     )
 
-    lro(client, response, status_codes=[200, 202], return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{dataset_name}' semantic model has been updated within the '{workspace_name}' workspace."
     )
@@ -333,7 +331,6 @@ def get_semantic_model_bim(
     dataset: str | UUID,
     workspace: Optional[str | UUID] = None,
     save_to_file_name: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
 ) -> dict:
     """
     Extracts the Model.bim file for a given semantic model.
@@ -348,10 +345,6 @@ def get_semantic_model_bim(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     save_to_file_name : str, default=None
         If specified, saves the Model.bim as a file in the lakehouse attached to the notebook.
-    lakehouse_workspace : str, default=None
-        The Fabric workspace name in which the lakehouse attached to the workspace resides.
-        Defaults to None which resolves to the workspace of the attached lakehouse
-        or if no lakehouse attached, resolves to the workspace of the notebook.
 
     Returns
     -------
@@ -375,9 +368,7 @@ def get_semantic_model_bim(
                 f"{icons.red_dot} In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
             )
 
-        lakehouse_id = fabric.get_lakehouse_id()
-        lake_workspace = fabric.resolve_workspace_name()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, lake_workspace)
+        lakehouse = resolve_lakehouse_name()
         folderPath = "/lakehouse/default/Files"
         fileExt = ".bim"
         if not save_to_file_name.endswith(fileExt):
@@ -437,11 +428,12 @@ def get_semantic_model_definition(
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/getDefinition?format={format}",
+    result = _base_api(
+        request=f"v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/getDefinition?format={format}",
+        method="post",
+        lro_return_json=True,
+        status_codes=None,
     )
-    result = lro(client, response).json()
 
     files = result["definition"]["parts"]