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

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/_environments.py

@@ -4,8 +4,10 @@ from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
     _create_dataframe,
+    resolve_item_id,
+    delete_item,
+    create_item,
 )
 from uuid import UUID
 
@@ -32,25 +34,11 @@ def create_environment(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": environment}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request="/v1/workspaces/{workspace_id}/environments",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=environment,
-        item_type="environment",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=environment,
+        description=description,
+        type="Environment",
+        workspace=workspace,
     )
 
 
@@ -98,7 +86,7 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
-def delete_environment(environment: str, workspace: Optional[str | UUID] = None):
+def delete_environment(environment: str | UUID, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric environment.
 
@@ -106,34 +94,20 @@ def delete_environment(environment: str, workspace: Optional[str | UUID] = None)
 
     Parameters
     ----------
-    environment: str
-        Name of the environment.
+    environment: str | uuid.UUID
+        Name or ID of the environment.
     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.
     """
 
-    from sempy_labs._helper_functions import resolve_environment_id
+    delete_item(item=environment, type="Environment", workspace=workspace)
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace_id
-    )
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}",
-        method="delete",
-    )
-    _print_success(
-        item_name=environment,
-        item_type="environment",
-        workspace_name=workspace_name,
-        action="deleted",
-    )
 
-
-def publish_environment(environment: str, workspace: Optional[str | UUID] = None):
+def publish_environment(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+):
     """
     Publishes a Fabric environment.
 
@@ -141,23 +115,21 @@ def publish_environment(environment: str, workspace: Optional[str | UUID] = None
 
     Parameters
     ----------
-    environment: str
-        Name of the environment.
+    environment: str | uuid.UUID
+        Name or ID of the environment.
     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.
     """
 
-    from sempy_labs._helper_functions import resolve_environment_id
-
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace_id
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
     )
 
     _base_api(
-        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}/staging/publish",
+        request=f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/publish",
         method="post",
         lro_return_status_code=True,
         status_codes=None,

sempy_labs/_eventhouses.py

@@ -1,14 +1,15 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
     resolve_item_id,
     _create_dataframe,
     _conv_b64,
     _decode_b64,
+    delete_item,
+    create_item,
+    get_item_definition,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -39,18 +40,11 @@ def create_eventhouse(
         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
+    if definition is not None and not isinstance(definition, dict):
+        raise ValueError(f"{icons.red_dot} The definition must be a dictionary.")
 
-    if definition is not None:
-        if not isinstance(definition, dict):
-            raise ValueError(f"{icons.red_dot} The definition must be a dictionary.")
-
-        payload["definition"] = {
+    definition_payload = (
+        {
             "parts": [
                 {
                     "path": "EventhouseProperties.json",
@@ -59,19 +53,16 @@ def create_eventhouse(
                 }
             ]
         }
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventhouses",
-        method="post",
-        status_codes=[201, 202],
-        payload=payload,
-        lro_return_status_code=True,
+        if definition is not None
+        else None
     )
-    _print_success(
-        item_name=name,
-        item_type="eventhouse",
-        workspace_name=workspace_name,
-        action="created",
+
+    create_item(
+        name=name,
+        type="Eventhouse",
+        workspace=workspace,
+        description=description,
+        definition=definition_payload,
     )
 
 
@@ -135,16 +126,7 @@ def delete_eventhouse(name: str, workspace: Optional[str | UUID] = None):
         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="Eventhouse", workspace=workspace)
-
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name,
-        item_type="eventhouse",
-        workspace_name=workspace_name,
-        action="deleted",
-    )
+    delete_item(item=name, type="Eventhouse", workspace=workspace)
 
 
 def get_eventhouse_definition(
@@ -174,21 +156,9 @@ def get_eventhouse_definition(
         The eventhouse definition in .json format or as a pandas dataframe.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = resolve_item_id(item=eventhouse, type="Eventhouse", workspace=workspace)
-
-    result = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventhouses/{item_id}/getDefinition",
-        method="post",
-        status_codes=None,
-        lro_return_json=True,
+    return get_item_definition(
+        item=eventhouse,
+        type="Eventhouse",
+        workspace=workspace,
+        return_dataframe=return_dataframe,
     )
-
-    df = pd.json_normalize(result["definition"]["parts"])
-
-    if return_dataframe:
-        return df
-    else:
-        df_filt = df[df["path"] == "EventhouseProperties.json"]
-        payload = df_filt["payload"].iloc[0]
-        return _decode_b64(payload)

sempy_labs/_eventstreams.py

@@ -1,14 +1,14 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
-    resolve_item_id,
+    delete_item,
     _create_dataframe,
+    create_item,
 )
 from uuid import UUID
+import sempy_labs._icons as icons
 
 
 def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
@@ -74,29 +74,14 @@ def create_eventstream(
         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}/eventstreams",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="eventstream",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="Eventstream", workspace=workspace
     )
 
 
-def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None):
+def delete_eventstream(
+    eventstream: str | UUID, workspace: Optional[str | UUID] = None, **kwargs
+):
     """
     Deletes a Fabric eventstream.
 
@@ -104,7 +89,7 @@ def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None)
 
     Parameters
     ----------
-    name: str | uuid.UUID
+    eventstream: str | uuid.UUID
         Name or ID of the eventstream.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
@@ -112,13 +97,10 @@ def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None)
         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="Eventstream", workspace=workspace)
-
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name,
-        item_type="eventstream",
-        workspace_name=workspace_name,
-        action="deleted",
-    )
+    if "name" in kwargs:
+        eventstream = kwargs["name"]
+        print(
+            f"{icons.warning} The 'name' parameter is deprecated. Please use 'eventstream' instead."
+        )
+
+    delete_item(item=eventstream, type="Eventstream", workspace=workspace)

sempy_labs/_gateways.py

@@ -314,7 +314,7 @@ def create_vnet_gateway(
         The name of the subnet.
     """
 
-    capacity_id = resolve_capacity_id(capacity)
+    capacity_id = resolve_capacity_id(capacity=capacity)
     payload = {
         "type": "VirtualNetwork",
         "displayName": name,
@@ -343,7 +343,7 @@ def create_vnet_gateway(
 
 
 def update_on_premises_gateway(
-    gateway: str,
+    gateway: str | UUID,
     allow_cloud_connection_refresh: Optional[bool] = None,
     allow_custom_connectors: Optional[bool] = None,
     load_balancing_setting: Optional[str] = None,
@@ -396,7 +396,7 @@ def update_on_premises_gateway(
 
 
 def update_vnet_gateway(
-    gateway: str,
+    gateway: str | UUID,
     capacity: str | UUID,
     inactivity_minutes_before_sleep: Optional[int] = None,
     number_of_member_gateways: Optional[int] = None,
@@ -425,7 +425,7 @@ def update_vnet_gateway(
     payload = {}
 
     if capacity is not None:
-        capacity_id = resolve_capacity_id(capacity)
+        capacity_id = resolve_capacity_id(capacity=capacity)
         payload["capacityId"] = capacity_id
     if inactivity_minutes_before_sleep is not None:
         payload["inactivityMinutesBeforeSleep"] = inactivity_minutes_before_sleep

sempy_labs/_generate_semantic_model.py

@@ -5,7 +5,6 @@ import os
 from typing import Optional, List
 from sempy._utils._log import log
 from sempy_labs._helper_functions import (
-    resolve_lakehouse_name,
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     _conv_b64,

sempy_labs/_git.py

@@ -4,6 +4,7 @@ from typing import Optional, List
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
+    _create_dataframe,
 )
 from uuid import UUID
 
@@ -126,7 +127,7 @@ def connect_workspace_to_github(
 
 def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
     """
-    Disconnects a workpsace from a git repository.
+    Disconnects a workspace from a git repository.
 
     This is a wrapper function for the following API: `Git - Disconnect <https://learn.microsoft.com/rest/api/fabric/core/git/disconnect>`_.
 
@@ -432,3 +433,91 @@ def update_from_git(
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been updated with commits pushed to the connected branch."
     )
+
+
+def get_my_git_credentials(
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
+    """
+    Returns the user's Git credentials configuration details.
+
+    This is a wrapper function for the following API: `Git - Get My Git Credentials <https://learn.microsoft.com/rest/api/fabric/core/git/get-my-git-credentials>`_.
+
+    Parameters
+    ----------
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the user's Git credentials configuration details.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    columns = {
+        "Source": "string",
+    }
+
+    df = _create_dataframe(columns)
+
+    response = _base_api(request=f"/v1/workspaces/{workspace_id}/git/myGitCredentials")
+
+    r = response.json()
+    new_data = {
+        "Source": r.get("source"),
+        "Connection Id": r.get("connectionId"),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def update_my_git_credentials(
+    source: str,
+    connection_id: Optional[UUID] = None,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Updates the user's Git credentials configuration details.
+
+    This is a wrapper function for the following API: `Git - Update My Git Credentials <https://learn.microsoft.com/rest/api/fabric/core/git/update-my-git-credentials>`_.
+
+    Parameters
+    ----------
+    source : str
+        The Git credentials source. Valid options: 'Automatic', 'ConfiguredConnection', 'None'.
+    connection_id : UUID, default=None
+        The object ID of the connection. Valid only for the 'ConfiguredConnection' source.
+    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_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    if source == "ConfiguredConnection" and connection_id is None:
+        raise ValueError(
+            f"{icons.red_dot} The 'ConfiguredConnection' source requires a connection_id."
+        )
+
+    payload = {
+        "source": source,
+    }
+
+    if connection_id is not None:
+        payload["connectionId"] = connection_id
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/myGitCredentials",
+        method="patch",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The user's Git credentials have been updated accordingly."
+    )

sempy_labs/_graphQL.py

@@ -5,7 +5,7 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_name_and_id,
-    _print_success,
+    create_item,
 )
 
 
@@ -73,23 +73,6 @@ def create_graphql_api(
         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}/GraphQLApis",
-        method="post",
-        status_codes=[201, 202],
-        payload=payload,
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="GraphQL API",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="GraphQLApi", workspace=workspace
     )