semantic-link-labs 0.9.4__py3-none-any.whl → 0.9.6__py3-none-any.whl

sempy_labs/_capacities.py

@@ -242,7 +242,7 @@ def list_vcores() -> pd.DataFrame:
 
 def get_capacity_resource_governance(capacity_name: str):
 
-    dfC = fabric.list_capacities()
+    dfC = list_capacities()
     dfC_filt = dfC[dfC["Display Name"] == capacity_name]
     capacity_id = dfC_filt["Id"].iloc[0].upper()
 
@@ -256,7 +256,6 @@ def suspend_fabric_capacity(
     capacity_name: str,
     azure_subscription_id: str,
     resource_group: str,
-    **kwargs,
 ):
     """
     This function suspends a Fabric capacity.
@@ -275,26 +274,9 @@ def suspend_fabric_capacity(
         The name of the Azure resource group.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Fabric/capacities/{capacity_name}/suspend?api-version={icons.azure_api_version}"
 
-    response = requests.post(url, headers=headers)
-
-    if response.status_code != 202:
-        raise FabricHTTPException(response)
+    _base_api(request=url, client="azure", method="post", status_codes=202)
 
     print(f"{icons.green_dot} The '{capacity_name}' capacity has been suspended.")
 
@@ -304,7 +286,6 @@ def resume_fabric_capacity(
     capacity_name: str,
     azure_subscription_id: str,
     resource_group: str,
-    **kwargs,
 ):
     """
     This function resumes a Fabric capacity.
@@ -323,26 +304,9 @@ def resume_fabric_capacity(
         The name of the Azure resource group.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Fabric/capacities/{capacity_name}/resume?api-version={icons.azure_api_version}"
 
-    response = requests.post(url, headers=headers)
-
-    if response.status_code != 202:
-        raise FabricHTTPException(response)
+    _base_api(request=url, client="azure", method="post", status_codes=202)
 
     print(f"{icons.green_dot} The '{capacity_name}' capacity has been resumed.")
 
@@ -352,7 +316,6 @@ def delete_embedded_capacity(
     capacity_name: str,
     azure_subscription_id: str,
     resource_group: str,
-    **kwargs,
 ):
     """
     This function deletes a Power BI Embedded capacity.
@@ -369,53 +332,36 @@ def delete_embedded_capacity(
         The name of the Azure resource group.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.PowerBIDedicated/capacities/{capacity_name}?api-version={icons.azure_api_version}"
 
-    response = requests.delete(url, headers=headers)
-
-    if response.status_code not in [200, 202]:
-        raise FabricHTTPException(response)
+    _base_api(request=url, client="azure", method="delete", status_codes=[200, 202])
 
     print(f"{icons.green_dot} The '{capacity_name}' capacity has been deleted.")
 
 
 @log
-def delete_premium_capacity(capacity_name: str):
+def delete_premium_capacity(capacity: str | UUID, **kwargs):
     """
     This function deletes a Power BI Premium capacity.
 
     Parameters
     ----------
-    capacity_name : str
-        Name of the Fabric capacity.
+    capacity : str | uuid.UUID
+        Name or ID of the Fabric capacity.
     """
+    from sempy_labs._helper_functions import resolve_capacity_id
 
-    dfC = fabric.list_capacities()
-
-    dfC_filt = dfC[dfC["Display Name"] == capacity_name]
-    if len(dfC_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{capacity_name}' capacity does not exist."
+    if "capacity_name" in kwargs:
+        capacity = kwargs["capacity_name"]
+        print(
+            f"{icons.warning} The 'capacity_name' parameter is deprecated. Please use 'capacity' instead."
         )
-    capacity_id = dfC_filt["Id"].iloc[0].upper()
+
+    capacity_id = resolve_capacity_id(capacity=capacity).upper()
 
     _base_api(request=f"capacities/{capacity_id}", method="delete", status_codes=204)
 
-    print(f"{icons.green_dot} The '{capacity_name}' capacity has been deleted.")
+    print(f"{icons.green_dot} The '{capacity}' capacity has been deleted.")
 
 
 @log
@@ -423,7 +369,6 @@ def delete_fabric_capacity(
     capacity_name: str,
     azure_subscription_id: str,
     resource_group: str,
-    **kwargs,
 ):
     """
     This function deletes a Fabric capacity.
@@ -442,26 +387,9 @@ def delete_fabric_capacity(
         The name of the Azure resource group.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Fabric/capacities/{capacity_name}?api-version={icons.azure_api_version}"
 
-    response = requests.delete(url, headers=headers)
-
-    if response.status_code != 202:
-        raise FabricHTTPException(response)
+    _base_api(request=url, client="azure", method="delete", status_codes=202)
 
     print(f"{icons.green_dot} The '{capacity_name}' capacity has been deleted.")
 
@@ -474,7 +402,6 @@ def update_fabric_capacity(
     sku: Optional[str] = None,
     admin_members: Optional[str | List[str]] = None,
     tags: Optional[dict] = None,
-    **kwargs,
 ):
     """
     This function updates a Fabric capacity's properties.
@@ -499,25 +426,9 @@ def update_fabric_capacity(
         Tag(s) to add to the capacity. Example: {'tagName': 'tagValue'}.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Fabric/capacities/{capacity_name}?api-version={icons.azure_api_version}"
 
-    get_response = requests.get(url, headers=headers)
-    if get_response.status_code != 200:
-        raise FabricHTTPException(get_response)
+    get_response = _base_api(request=url, client="azure")
 
     get_json = get_response.json()
     current_sku = get_json.get("sku", {}).get("name")
@@ -549,10 +460,9 @@ def update_fabric_capacity(
         return
 
     payload = _add_sll_tag(payload, tags)
-    response = requests.patch(url, headers=headers, json=payload)
-
-    if response.status_code != 202:
-        raise FabricHTTPException(response)
+    _base_api(
+        request=url, client="azure", method="patch", payload=payload, status_codes=202
+    )
 
     print(
         f"{icons.green_dot} The '{capacity_name}' capacity has been updated accordingly."
@@ -588,28 +498,13 @@ def check_fabric_capacity_name_availablility(
         An indication as to whether the Fabric capacity name is available or not.
     """
 
-    token_provider = auth.token_provider.get()
-    if token_provider is None:
-        token_provider = ServicePrincipalTokenProvider.from_azure_key_vault(
-            key_vault_uri=kwargs["key_vault_uri"],
-            key_vault_tenant_id=kwargs["key_vault_tenant_id"],
-            key_vault_client_id=kwargs["key_vault_client_id"],
-            key_vault_client_secret=kwargs["key_vault_client_secret"],
-        )
-        print(
-            f"{icons.info} Please use the 'token_provider' parameter instead of the key vault parameters within this function as the key vault parameters have been deprecated."
-        )
-
-    headers = _get_headers(token_provider, audience="azure")
-
     payload = {"name": capacity_name, "type": "Microsoft.Fabric/capacities"}
 
     url = f"https://management.azure.com/subscriptions/{azure_subscription_id}/providers/Microsoft.Fabric/locations/{region}/checkNameAvailability?api-version={icons.azure_api_version}"
 
-    response = requests.post(url, headers=headers, json=payload)
-
-    if response.status_code != 202:
-        raise FabricHTTPException(response)
+    response = _base_api(
+        request=url, client="azure", method="post", payload=payload, status_codes=202
+    )
 
     return bool(response.json().get("nameAvailable"))
 
@@ -1236,3 +1131,39 @@ def get_resource_group(azure_subscription_id: str, resource_group: str) -> pd.Da
     }
 
     return pd.DataFrame(new_data, index=[0])
+
+
+def list_capacities() -> pd.DataFrame:
+    """
+    Shows the capacities and their properties.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the capacities and their properties
+    """
+
+    columns = {
+        "Id": "string",
+        "Display Name": "string",
+        "Sku": "string",
+        "Region": "string",
+        "State": "string",
+        "Admins": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    response = _base_api(request="/v1.0/myorg/capacities", client="fabric_sp")
+
+    for i in response.json().get("value", []):
+        new_data = {
+            "Id": i.get("id").lower(),
+            "Display Name": i.get("displayName"),
+            "Sku": i.get("sku"),
+            "Region": i.get("region"),
+            "State": i.get("state"),
+            "Admins": [i.get("admins", [])],
+        }
+        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df

sempy_labs/_capacity_migration.py

@@ -16,6 +16,7 @@ from sempy_labs._helper_functions import (
     _base_api,
 )
 from sempy_labs._capacities import create_fabric_capacity
+from uuid import UUID
 
 
 def _migrate_settings(source_capacity: str, target_capacity: str):
@@ -105,17 +106,13 @@ def migrate_workspaces(
     migrated_workspaces = []
 
     for i, r in dfW.iterrows():
-        workspace = r["Name"]
-
-        if workspaces is None or workspace in workspaces:
-            pass
-        else:
-            continue
-
-        if assign_workspace_to_capacity(
-            capacity_name=target_capacity, workspace=workspace
-        ):
-            migrated_workspaces.append(workspace)
+        workspace_id = r["Id"]
+        workspace_name = r["Name"]
+        if workspaces is None or workspace_name in workspaces:
+            assign_workspace_to_capacity(
+                capacity=target_capacity, workspace=workspace_id
+            )
+            migrated_workspaces.append(workspace_name)
 
     if len(migrated_workspaces) < workspace_count:
         print(
@@ -123,10 +120,11 @@ def migrate_workspaces(
         )
         print(f"{icons.in_progress} Initiating rollback...")
         for i, r in dfW.iterrows():
-            workspace = r["Name"]
-            if workspace in migrated_workspaces:
+            workspace_id = r["Id"]
+            workspace_name = r["Name"]
+            if workspace_name in migrated_workspaces:
                 assign_workspace_to_capacity(
-                    capacity_name=source_capacity, workspace=workspace
+                    capacity=source_capacity, workspace=workspace_id
                 )
         print(
             f"{icons.green_dot} Rollback of the workspaces to the '{source_capacity}' capacity is complete."
@@ -531,7 +529,7 @@ def _migrate_delegated_tenant_settings(source_capacity: str, target_capacity: st
 
 
 @log
-def _migrate_spark_settings(source_capacity: str, target_capacity: str):
+def _migrate_spark_settings(source_capacity: str | UUID, target_capacity: str | UUID):
     """
     This function migrates a capacity's spark settings to another capacity.
 
@@ -539,14 +537,14 @@ def _migrate_spark_settings(source_capacity: str, target_capacity: str):
 
     Parameters
     ----------
-    source_capacity : str
-        Name of the source capacity.
-    target_capacity : str
-        Name of the target capacity.
+    source_capacity : str | uuid.UUID
+        Name or ID of the source capacity.
+    target_capacity : str | uuid.UUID
+        Name or ID of the target capacity.
     """
 
-    source_capacity_id = resolve_capacity_id(capacity_name=source_capacity)
-    target_capacity_id = resolve_capacity_id(capacity_name=target_capacity)
+    source_capacity_id = resolve_capacity_id(capacity=source_capacity)
+    target_capacity_id = resolve_capacity_id(capacity=target_capacity)
 
     # Get source capacity server dns
     response = _base_api(request=f"metadata/capacityInformation/{source_capacity_id}")

sempy_labs/_connections.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
@@ -7,6 +6,7 @@ from sempy_labs._helper_functions import (
     _update_dataframe_datatypes,
     _base_api,
     _create_dataframe,
+    resolve_item_id,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -230,9 +230,7 @@ def list_item_connections(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     item_type = item_type[0].upper() + item_type[1:]
-    item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     columns = {
         "Connection Name": "string",

sempy_labs/_dashboards.py

@@ -0,0 +1,60 @@
+from typing import Optional
+from uuid import UUID
+import pandas as pd
+from sempy_labs._helper_functions import (
+    _create_dataframe,
+    _base_api,
+    resolve_workspace_name_and_id,
+    _update_dataframe_datatypes,
+)
+
+
+def list_dashboards(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows a list of the dashboards within a workspace.
+
+    Parameters
+    ----------
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the dashboards within a workspace.
+    """
+
+    columns = {
+        "Dashboard ID": "string",
+        "Dashboard Name": "string",
+        "Read Only": "bool",
+        "Web URL": "string",
+        "Embed URL": "string",
+        "Data Classification": "string",
+        "Users": "string",
+        "Subscriptions": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    response = _base_api(request=f"/v1.0/myorg/groups/{workspace_id}/dashboards")
+
+    for v in response.json().get("value", []):
+        new_data = {
+            "Dashboard ID": v.get("id"),
+            "Dashboard Name": v.get("displayName"),
+            "Read Only": v.get("isReadOnly"),
+            "Web URL": v.get("webUrl"),
+            "Embed URL": v.get("embedUrl"),
+            "Data Classification": v.get("dataClassification"),
+            "Users": v.get("users"),
+            "Subscriptions": v.get("subscriptions"),
+        }
+        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df

sempy_labs/_data_pipelines.py

@@ -1,13 +1,13 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _decode_b64,
     _base_api,
-    _print_success,
     resolve_item_id,
     _create_dataframe,
+    delete_item,
+    create_item,
 )
 from uuid import UUID
 
@@ -76,25 +76,8 @@ def create_data_pipeline(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        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,
-    )
-    _print_success(
-        item_name=name,
-        item_type="data pipeline",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="DataPipeline", workspace=workspace
     )
 
 
@@ -114,16 +97,7 @@ def delete_data_pipeline(name: str | UUID, workspace: Optional[str | UUID] = Non
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    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",
-    )
+    delete_item(item=name, type="DataPipeline", workspace=workspace)
 
 
 def get_data_pipeline_definition(

sempy_labs/_dataflows.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 import pandas as pd
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
@@ -6,6 +5,7 @@ from sempy_labs._helper_functions import (
     _update_dataframe_datatypes,
     _base_api,
     _create_dataframe,
+    resolve_workspace_name,
 )
 from typing import Optional, Tuple
 import sempy_labs._icons as icons
@@ -187,7 +187,7 @@ def list_upstream_dataflows(
         for v in values:
             tgt_dataflow_id = v.get("targetDataflowId")
             tgt_workspace_id = v.get("groupId")
-            tgt_workspace_name = fabric.resolve_workspace_name(tgt_workspace_id)
+            tgt_workspace_name = resolve_workspace_name(workspace_id=tgt_workspace_id)
             (tgt_dataflow_name, _) = _resolve_dataflow_name_and_id(
                 dataflow=tgt_dataflow_id, workspace=tgt_workspace_id
             )

sempy_labs/_dax_query_view.py

@@ -0,0 +1,55 @@
+from typing import Optional
+from uuid import UUID
+from sempy_labs._helper_functions import (
+    resolve_dataset_id,
+    _get_fabric_context_setting,
+    resolve_workspace_id,
+)
+import gzip
+import base64
+import urllib.parse
+
+
+def generate_dax_query_view_url(
+    dataset: str | UUID, dax_string: str, workspace: Optional[str | UUID] = None
+):
+    """
+    Prints a URL based on query provided. This URL opens `DAX query view <https://learn.microsoft.com/power-bi/transform-model/dax-query-view>`_ in the Power BI service, connected to the semantic model and using the query provided.
+
+    Parameters
+    ----------
+    dataset : str | uuid.UUID
+        The semantic model name or ID.
+    dax_string : str
+        The DAX query string.
+    workspace : str | uuid.UUID, default=None
+        The 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.
+    """
+
+    workspace_id = resolve_workspace_id(workspace=workspace)
+    dataset_id = resolve_dataset_id(dataset=dataset, workspace=workspace_id)
+
+    prefix = _get_fabric_context_setting(name="spark.trident.pbienv").lower()
+
+    if prefix == "prod":
+        prefix = "app"
+
+    def gzip_base64_urlsafe(input_string):
+        # Compress the string with gzip
+        compressed_data = gzip.compress(input_string.encode("utf-8"))
+
+        # Encode the compressed data in base64
+        base64_data = base64.b64encode(compressed_data)
+
+        # Make the base64 string URL-safe
+        urlsafe_data = urllib.parse.quote_plus(base64_data.decode("utf-8"))
+
+        return urlsafe_data
+
+    formatted_query = gzip_base64_urlsafe(dax_string)
+
+    url = f"https://{prefix}.powerbi.com/groups/{workspace_id}/modeling/{dataset_id}/daxQueryView?query={formatted_query}"
+
+    print(url)