semantic-link-labs 0.8.9__py3-none-any.whl → 0.8.11__py3-none-any.whl

sempy_labs/_environments.py

@@ -8,10 +8,13 @@ from sempy_labs._helper_functions import (
     pagination,
 )
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
 def create_environment(
-    environment: str, description: Optional[str] = None, workspace: Optional[str] = None
+    environment: str,
+    description: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Creates a Fabric environment.
@@ -24,13 +27,13 @@ def create_environment(
         Name of the environment.
     description : str, default=None
         A description of the environment.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     request_body = {"displayName": environment}
 
@@ -45,11 +48,11 @@ def create_environment(
     lro(client, response, status_codes=[201, 202])
 
     print(
-        f"{icons.green_dot} The '{environment}' environment has been created within the '{workspace}' workspace."
+        f"{icons.green_dot} The '{environment}' environment has been created within the '{workspace_name}' workspace."
     )
 
 
-def list_environments(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the environments within a workspace.
 
@@ -57,8 +60,8 @@ def list_environments(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -70,7 +73,7 @@ def list_environments(workspace: Optional[str] = None) -> pd.DataFrame:
 
     df = pd.DataFrame(columns=["Environment Name", "Environment Id", "Description"])
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.get(f"/v1/workspaces/{workspace_id}/environments")
@@ -91,7 +94,7 @@ def list_environments(workspace: Optional[str] = None) -> pd.DataFrame:
     return df
 
 
-def delete_environment(environment: str, workspace: Optional[str] = None):
+def delete_environment(environment: str, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric environment.
 
@@ -101,17 +104,17 @@ def delete_environment(environment: str, workspace: Optional[str] = None):
     ----------
     environment: str
         Name of the environment.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace
+        environment=environment, workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -123,31 +126,31 @@ def delete_environment(environment: str, workspace: Optional[str] = None):
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{environment}' environment within the '{workspace}' workspace has been deleted."
+        f"{icons.green_dot} The '{environment}' environment within the '{workspace_name}' workspace has been deleted."
     )
 
 
-def publish_environment(environment: str, workspace: Optional[str] = None):
+def publish_environment(environment: str, 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>`_.
+
     Parameters
     ----------
     environment: str
         Name of the environment.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
     """
 
-    # https://learn.microsoft.com/en-us/rest/api/fabric/environment/spark-libraries/publish-environment?tabs=HTTP
-
     from sempy_labs._helper_functions import resolve_environment_id
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace
+        environment=environment, workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -158,5 +161,5 @@ def publish_environment(environment: str, workspace: Optional[str] = None):
     lro(client, response)
 
     print(
-        f"{icons.green_dot} The '{environment}' environment within the '{workspace}' workspace has been published."
+        f"{icons.green_dot} The '{environment}' environment within the '{workspace_name}' workspace has been published."
     )

sempy_labs/_eventhouses.py

@@ -8,10 +8,11 @@ from sempy_labs._helper_functions import (
     pagination,
 )
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
 def create_eventhouse(
-    name: str, description: Optional[str] = None, workspace: Optional[str] = None
+    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
 ):
     """
     Creates a Fabric eventhouse.
@@ -24,13 +25,13 @@ def create_eventhouse(
         Name of the eventhouse.
     description : str, default=None
         A description of the environment.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     request_body = {"displayName": name}
 
@@ -45,11 +46,11 @@ def create_eventhouse(
     lro(client, response, status_codes=[201, 202])
 
     print(
-        f"{icons.green_dot} The '{name}' eventhouse has been created within the '{workspace}' workspace."
+        f"{icons.green_dot} The '{name}' eventhouse has been created within the '{workspace_name}' workspace."
     )
 
 
-def list_eventhouses(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_eventhouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the eventhouses within a workspace.
 
@@ -57,8 +58,8 @@ def list_eventhouses(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -70,7 +71,7 @@ def list_eventhouses(workspace: Optional[str] = None) -> pd.DataFrame:
 
     df = pd.DataFrame(columns=["Eventhouse Name", "Eventhouse Id", "Description"])
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.get(f"/v1/workspaces/{workspace_id}/eventhouses")
@@ -91,7 +92,7 @@ def list_eventhouses(workspace: Optional[str] = None) -> pd.DataFrame:
     return df
 
 
-def delete_eventhouse(name: str, workspace: Optional[str] = None):
+def delete_eventhouse(name: str, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric eventhouse.
 
@@ -101,16 +102,16 @@ def delete_eventhouse(name: str, workspace: Optional[str] = None):
     ----------
     name: str
         Name of the eventhouse.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     item_id = fabric.resolve_item_id(
-        item_name=name, type="Eventhouse", workspace=workspace
+        item_name=name, type="Eventhouse", workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -120,5 +121,5 @@ def delete_eventhouse(name: str, workspace: Optional[str] = None):
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{name}' eventhouse within the '{workspace}' workspace has been deleted."
+        f"{icons.green_dot} The '{name}' eventhouse within the '{workspace_name}' workspace has been deleted."
     )

sempy_labs/_eventstreams.py

@@ -8,9 +8,10 @@ from sempy_labs._helper_functions import (
     pagination,
 )
 from sempy.fabric.exceptions import FabricHTTPException
+from uuid import UUID
 
 
-def list_eventstreams(workspace: Optional[str] = None) -> pd.DataFrame:
+def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the eventstreams within a workspace.
 
@@ -18,8 +19,8 @@ def list_eventstreams(workspace: Optional[str] = None) -> pd.DataFrame:
 
     Parameters
     ----------
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -31,7 +32,7 @@ def list_eventstreams(workspace: Optional[str] = None) -> pd.DataFrame:
 
     df = pd.DataFrame(columns=["Eventstream Name", "Eventstream Id", "Description"])
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     client = fabric.FabricRestClient()
     response = client.get(f"/v1/workspaces/{workspace_id}/eventstreams")
@@ -53,7 +54,7 @@ def list_eventstreams(workspace: Optional[str] = None) -> pd.DataFrame:
 
 
 def create_eventstream(
-    name: str, description: Optional[str] = None, workspace: Optional[str] = None
+    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
 ):
     """
     Creates a Fabric eventstream.
@@ -66,13 +67,13 @@ def create_eventstream(
         Name of the eventstream.
     description : str, default=None
         A description of the environment.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     request_body = {"displayName": name}
 
@@ -87,11 +88,11 @@ def create_eventstream(
     lro(client, response, status_codes=[201, 202])
 
     print(
-        f"{icons.green_dot} The '{name}' eventstream has been created within the '{workspace}' workspace."
+        f"{icons.green_dot} The '{name}' eventstream has been created within the '{workspace_name}' workspace."
     )
 
 
-def delete_eventstream(name: str, workspace: Optional[str] = None):
+def delete_eventstream(name: str, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric eventstream.
 
@@ -101,16 +102,16 @@ def delete_eventstream(name: str, workspace: Optional[str] = None):
     ----------
     name: str
         Name of the eventstream.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     item_id = fabric.resolve_item_id(
-        item_name=name, type="Eventstream", workspace=workspace
+        item_name=name, type="Eventstream", workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -120,5 +121,5 @@ def delete_eventstream(name: str, workspace: Optional[str] = None):
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{name}' eventstream within the '{workspace}' workspace has been deleted."
+        f"{icons.green_dot} The '{name}' eventstream within the '{workspace_name}' workspace has been deleted."
     )

sempy_labs/_external_data_shares.py

@@ -15,7 +15,7 @@ def create_external_data_share(
     item_type: str,
     paths: str | List[str],
     recipient: str,
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Creates an external data share for a given path or list of paths in the specified item.
@@ -32,17 +32,15 @@ def create_external_data_share(
         The path or list of paths that are to be externally shared. Currently, only a single path is supported.
     recipient : str
         The email address of the recipient.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
     """
 
-    # https://learn.microsoft.com/en-us/rest/api/fabric/core/external-data-shares/create-external-data-share?tabs=HTTP
-
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace
+        item_name=item_name, type=item_type, workspace=workspace_id
     )
 
     if isinstance(paths, str):
@@ -60,7 +58,7 @@ def create_external_data_share(
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} An external data share was created for the '{item_name}' {item_type} within the '{workspace}' workspace for the {paths} paths."
+        f"{icons.green_dot} An external data share was created for the '{item_name}' {item_type} within the '{workspace_name}' workspace for the {paths} paths."
     )
 
 
@@ -68,7 +66,7 @@ def revoke_external_data_share(
     external_data_share_id: UUID,
     item_name: str,
     item_type: str,
-    workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Revokes the specified external data share. Note: This action cannot be undone.
@@ -77,21 +75,21 @@ def revoke_external_data_share(
 
     Parameters
     ----------
-    external_data_share_id : UUID
+    external_data_share_id : uuid.UUID
         The external data share ID.
     item_name : str
         The item name.
     item_type : str
         The `item type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace
+        item_name=item_name, type=item_type, workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()
@@ -103,12 +101,12 @@ def revoke_external_data_share(
         raise FabricHTTPException(response)
 
     print(
-        f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace}' workspace has been revoked."
+        f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_name}' {item_type} within the '{workspace_name}' workspace has been revoked."
     )
 
 
 def list_external_data_shares_in_item(
-    item_name: str, item_type: str, workspace: Optional[str] = None
+    item_name: str, item_type: str, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
     """
     Returns a list of the external data shares that exist for the specified item.
@@ -121,8 +119,8 @@ def list_external_data_shares_in_item(
         The item name.
     item_type : str
         The `item type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_.
-    workspace : str, default=None
-        The Fabric workspace name.
+    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.
 
@@ -132,9 +130,9 @@ def list_external_data_shares_in_item(
         A pandas dataframe showing a list of the external data shares that exist for the specified item.
     """
 
-    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace
+        item_name=item_name, type=item_type, workspace=workspace_id
     )
 
     client = fabric.FabricRestClient()

sempy_labs/_gateways.py

@@ -6,6 +6,8 @@ from sempy_labs._helper_functions import (
     pagination,
     _is_valid_uuid,
     resolve_capacity_id,
+    resolve_workspace_name_and_id,
+    resolve_dataset_name_and_id,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -93,7 +95,7 @@ def delete_gateway(gateway: str | UUID):
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
     """
 
@@ -115,7 +117,7 @@ def list_gateway_role_assigments(gateway: str | UUID) -> pd.DataFrame:
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
 
     Returns
@@ -157,9 +159,9 @@ def delete_gateway_role_assignment(gateway: str | UUID, role_assignement_id: UUI
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
-    role_assignement_id : UUID
+    role_assignement_id : uuid.UUID
         The role assignment ID.
     """
 
@@ -202,9 +204,9 @@ def delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID):
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
-    gateway_member : str | UUID
+    gateway_member : str | uuid.UUID
         The gateway member name or ID.
     """
 
@@ -232,7 +234,7 @@ def list_gateway_members(gateway: str | UUID) -> pd.DataFrame:
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
 
     Returns
@@ -296,7 +298,7 @@ def create_vnet_gateway(
     ----------
     name : str
         The gateway name.
-    capacity : str | UUID
+    capacity : str | uuid.UUID
         The capacity name or Id.
     inactivity_minutes_before_sleep : int
         The minutes of inactivity before the virtual network gateway goes into auto-sleep. Must be one of the following values: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
@@ -351,7 +353,7 @@ def update_on_premises_gateway(
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
     allow_cloud_connection_refresh : bool, default=None
         Whether to allow cloud connections to refresh through this on-premises gateway. True - Allow, False - Do not allow.
@@ -401,9 +403,9 @@ def update_vnet_gateway(
 
     Parameters
     ----------
-    gateway : str | UUID
+    gateway : str | uuid.UUID
         The gateway name or ID.
-    capacity: str | UUID
+    capacity: str | uuid.UUID
         The capacity name or ID.
     inactivity_minutes_before_sleep : int, default=None
         The minutes of inactivity before the virtual network gateway goes into auto-sleep. Must be one of the following values: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
@@ -437,3 +439,47 @@ def update_vnet_gateway(
         raise FabricHTTPException(response)
 
     print(f"{icons.green_dot} The '{gateway}' has been updated accordingly.")
+
+
+def bind_semantic_model_to_gateway(
+    dataset: str | UUID, gateway: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Binds the specified dataset from the specified workspace to the specified 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>`_.
+
+    Parameters
+    ----------
+    dataset : str | uuid.UUID
+        The name or ID of the semantic model.
+    gateway : str | uuid.UUID
+        The name or ID of the gateway.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name.
+        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)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(
+        dataset, workspace=workspace_id
+    )
+
+    gateway_id = _resolve_gateway_id(gateway)
+    payload = {
+        "gatewayObjectId": gateway_id,
+    }
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"/v1.0/myorg/groups/{workspace_id}/datasets/{dataset_id}/Default.BindToGateway",
+        json=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."
+    )