semantic-link-labs 0.12.8__py3-none-any.whl

sempy_labs/environment/_items.py

@@ -0,0 +1,212 @@
+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,
+    resolve_workspace_id,
+    _base_api,
+    _create_dataframe,
+    resolve_item_id,
+    delete_item,
+    create_item,
+)
+from uuid import UUID
+from sempy._utils._log import log
+
+
+@log
+def create_environment(
+    environment: str,
+    description: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Creates a Fabric environment.
+
+    This is a wrapper function for the following API: `Items - Create Environment <https://learn.microsoft.com/rest/api/fabric/environment/items/create-environment>`_.
+
+    Parameters
+    ----------
+    environment: str
+        Name of the environment.
+    description : str, default=None
+        A description 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.
+    """
+
+    create_item(
+        name=environment,
+        description=description,
+        type="Environment",
+        workspace=workspace,
+    )
+
+
+@log
+def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the environments within a workspace.
+
+    This is a wrapper function for the following API: `Items - List Environments <https://learn.microsoft.com/rest/api/fabric/environment/items/list-environments>`_.
+
+    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
+        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 environments within a workspace.
+    """
+
+    columns = {
+        "Environment Name": "string",
+        "Environment Id": "string",
+        "Description": "string",
+        "Publish State": "string",
+        "Publish Target Version": "string",
+        "Publish Start Time": "string",
+        "Publish End Time": "string",
+        "Spark Libraries State": "string",
+        "Spark Settings State": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments",
+        uses_pagination=True,
+        client="fabric_sp",
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            pub = v.get("properties", {}).get("publishDetails", {})
+            rows.append(
+                {
+                    "Environment Name": v.get("displayName"),
+                    "Environment Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Publish State": pub.get("state"),
+                    "Publish Target Version": pub.get("targetVersion"),
+                    "Publish Start Time": pub.get("startTime"),
+                    "Publish End Time": pub.get("endTime"),
+                    "Spark Libraries State": pub.get("componentPublishInfo", {})
+                    .get("sparkLibraries", {})
+                    .get("state"),
+                    "Spark Settings State": pub.get("componentPublishInfo", {})
+                    .get("sparkSettings", {})
+                    .get("state"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df
+
+
+@log
+def delete_environment(environment: str | UUID, workspace: Optional[str | UUID] = None):
+    """
+    Deletes a Fabric environment.
+
+    This is a wrapper function for the following API: `Items - Delete Environment <https://learn.microsoft.com/rest/api/fabric/environment/items/delete-environment>`_.
+
+    Parameters
+    ----------
+    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.
+    """
+
+    delete_item(item=environment, type="Environment", workspace=workspace)
+
+
+@log
+def publish_environment(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Publishes a Fabric environment.
+
+    This is a wrapper function for the following API: `Spark Libraries - Publish Environment <https://learn.microsoft.com/rest/api/fabric/environment/spark-libraries/publish-environment>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/publish",
+        method="post",
+        lro_return_status_code=True,
+        status_codes=None,
+        client="fabric_sp",
+    )
+
+    print(
+        f"{icons.green_dot} The '{environment}' environment within the '{workspace_name}' workspace has been published."
+    )
+
+
+@log
+def cancel_publish_environment(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Trigger an environment publish cancellation.
+
+    This is a wrapper function for the following API: `Items - Cancel Publish Environment <https://learn.microsoft.com/rest/api/fabric/environment/items/cancel-publish-environment>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/cancelPublish",
+        method="post",
+        client="fabric_sp",
+    )
+
+    print(
+        f"{icons.green_dot} The publish of the '{environment}' environment within the '{workspace_name}' workspace has been cancelled."
+    )

sempy_labs/environment/_pubstage.py

@@ -0,0 +1,223 @@
+import pandas as pd
+from typing import Optional
+from sempy_labs._helper_functions import (
+    resolve_workspace_id,
+    _base_api,
+    _create_dataframe,
+    resolve_item_id,
+    _update_dataframe_datatypes,
+)
+from uuid import UUID
+from sempy._utils._log import log
+
+
+def _get_spark_compute(
+    environment: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    staging: bool = False,
+) -> pd.DataFrame:
+
+    columns = {
+        "Instance Pool Name": "string",
+        "Instance Pool Type": "string",
+        "Instance Pool Id": "string",
+        "Driver Cores": "int",
+        "Driver Memory": "string",
+        "Executor Cores": "int",
+        "Executor Memory": "string",
+        "Dynamic Executor Allocation Enabled": "bool",
+        "Dynamic Executor Allocation Min Executors": "int",
+        "Dynamic Executor Allocation Max Executors": "int",
+        "Spark Properties": "string",
+        "Runtime Version": "string",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
+    )
+
+    url = f"/v1/workspaces/{workspace_id}/environments/{item_id}/sparkCompute"
+    if staging:
+        url = (
+            f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/sparkCompute"
+        )
+
+    response = _base_api(
+        request=url,
+        client="fabric_sp",
+    )
+
+    rows = []
+    rows.append(
+        {
+            "Instance Pool Name": response.get("instancePool", {}).get("name"),
+            "Instance Pool Type": response.get("instancePool", {}).get("type"),
+            "Instance Pool Id": response.get("instancePool", {}).get("id"),
+            "Driver Cores": response.get("driverCores"),
+            "Driver Memory": response.get("driverMemory"),
+            "Executor Cores": response.get("executorCores"),
+            "Executor Memory": response.get("executorMemory"),
+            "Dynamic Executor Allocation Enabled": response.get(
+                "dynamicExecutorAllocation", {}
+            ).get("enabled"),
+            "Dynamic Executor Allocation Min Executors": response.get(
+                "dynamicExecutorAllocation", {}
+            ).get("minExecutors"),
+            "Dynamic Executor Allocation Max Executors": response.get(
+                "dynamicExecutorAllocation", {}
+            ).get("maxExecutors"),
+            "Spark Properties": response.get("sparkProperties"),
+            "Runtime Version": response.get("runtimeVersion"),
+        }
+    )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(df, columns)
+
+    return df
+
+
+@log
+def get_published_spark_compute(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Gets the Spark compute of a published Fabric environment.
+
+    This is a wrapper function for the following API: `Published - Get Spark Compute <https://learn.microsoft.com/rest/api/fabric/environment/published/get-spark-compute>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    return _get_spark_compute(environment, workspace, staging=False)
+
+
+@log
+def get_staging_spark_compute(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Gets the Spark compute of a staging Fabric environment.
+
+    This is a wrapper function for the following API: `Staging - Get Spark Compute <https://learn.microsoft.com/rest/api/fabric/environment/staging/get-spark-compute>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    return _get_spark_compute(environment, workspace, staging=True)
+
+
+def _list_libraries(
+    environment: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    staging: bool = False,
+) -> pd.DataFrame:
+
+    columns = {
+        "Library Name": "string",
+        "Library Type": "string",
+        "Library Version": "string",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
+    )
+
+    url = f"/v1/workspaces/{workspace_id}/environments/{item_id}/libraries"
+    if staging:
+        url = f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/libraries"
+
+    responses = _base_api(
+        request=url,
+        client="fabric_sp",
+        uses_pagination=True,
+    )
+
+    rows = []
+    for r in responses:
+        for lib in r.get("libraries", []):
+            rows.append(
+                {
+                    "Library Name": lib.get("name"),
+                    "Library Type": lib.get("libraryType"),
+                    "Library Version": lib.get("version"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df
+
+
+@log
+def list_published_libraries(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Gets the published libraries of a Fabric environment.
+
+    This is a wrapper function for the following API: `Published - List Libraries <https://learn.microsoft.com/rest/api/fabric/environment/published/list-libraries>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    return _list_libraries(environment, workspace, staging=False)
+
+
+@log
+def list_staging_libraries(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Gets the staging libraries of a Fabric environment.
+
+    This is a wrapper function for the following API: `Staging - List Libraries <https://learn.microsoft.com/rest/api/fabric/environment/staging/list-libraries>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    return _list_libraries(environment, workspace, staging=True)

sempy_labs/eventstream/__init__.py

@@ -0,0 +1,37 @@
+from ._items import (
+    list_eventstreams,
+    create_eventstream,
+    delete_eventstream,
+    get_eventstream_definition,
+)
+from ._topology import (
+    get_eventstream_destination,
+    get_eventstream_destination_connection,
+    get_eventstream_source,
+    get_eventstream_source_connection,
+    get_eventstream_topology,
+    pause_eventstream,
+    pause_eventstream_destination,
+    pause_eventstream_source,
+    resume_eventstream,
+    resume_eventstream_destination,
+    resume_eventstream_source,
+)
+
+__all__ = [
+    "list_eventstreams",
+    "create_eventstream",
+    "delete_eventstream",
+    "get_eventstream_definition",
+    "get_eventstream_destination",
+    "get_eventstream_destination_connection",
+    "get_eventstream_source",
+    "get_eventstream_source_connection",
+    "get_eventstream_topology",
+    "pause_eventstream",
+    "pause_eventstream_destination",
+    "pause_eventstream_source",
+    "resume_eventstream",
+    "resume_eventstream_destination",
+    "resume_eventstream_source",
+]