semantic-link-labs 0.12.2__py3-none-any.whl → 0.12.4__py3-none-any.whl

sempy_labs/_semantic_models.py

@@ -348,3 +348,121 @@ def list_semantic_model_datasources(
         df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
+
+
+@log
+def bind_semantic_model_connection(
+    dataset: str | UUID,
+    connection_id: UUID,
+    connectivity_type: str,
+    connection_type: str,
+    connection_path: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Binds a semantic model data source reference to a data connection.
+    This API can also be used to unbind data source references.
+
+    This is a wrapper function for the following API: `Items - Bind Semantic Model Connection <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection>`_.
+
+    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
+        Name or ID of the semantic model.
+    connection_id : uuid.UUID
+        The object ID of the connection.
+    connectivity_type : str
+        The connectivity type of the connection. Additional connectivity types may be added over time.
+    connection_type : str
+        The `type <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection?tabs=HTTP#connectivitytype>`_ of the connection.
+    connection_path : str
+        The path of the connection.
+    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)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(
+        dataset=dataset, workspace=workspace_id
+    )
+
+    payload = {
+        "connectionBinding": {
+            "id": str(connection_id),
+            "connectivityType": connectivity_type,
+            "connectionDetails": {
+                "type": connection_type,
+                "path": connection_path,
+            },
+        }
+    }
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/bindConnection",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} Connection '{connection_id}' has been bound to the '{dataset_name}' semantic model within the '{workspace_name}' workspace."
+    )
+
+
+@log
+def unbind_semantic_model_connection(
+    dataset: str | UUID,
+    connection_type: str,
+    connection_path: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Unbinds a semantic model data source reference to a data connection.
+
+    This is a wrapper function for the following API: `Items - Bind Semantic Model Connection <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection>`_.
+
+    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
+        Name or ID of the semantic model.
+    connection_type : str
+        The `type <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection?tabs=HTTP#connectivitytype>`_ of the connection.
+    connection_path : str
+        The path of the connection.
+    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)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(
+        dataset=dataset, workspace=workspace_id
+    )
+
+    payload = {
+        "connectionBinding": {
+            "connectivityType": "None",
+            "connectionDetails": {
+                "type": connection_type,
+                "path": connection_path,
+            },
+        }
+    }
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/bindConnection",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{dataset_name}' semantic model within the '{workspace_name}' workspace has been unbound from its connection."
+    )

sempy_labs/_sql_audit_settings.py

@@ -0,0 +1,208 @@
+from sempy_labs._helper_functions import (
+    resolve_item_id,
+    resolve_workspace_name_and_id,
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    resolve_workspace_id,
+    resolve_item_name_and_id,
+)
+import pandas as pd
+from typing import Optional, List, Literal
+import sempy_labs._icons as icons
+from uuid import UUID
+from sempy._utils._log import log
+
+
+def _get_base_url(item, type, workspace):
+
+    workspace_id = resolve_workspace_id(workspace)
+    item_id = resolve_item_id(item=item, type=type, workspace=workspace)
+
+    type_dict = {
+        "Warehouse": "warehouses",
+        "SQLEndpoint": "sqlEndpoints",
+    }
+    type_for_url = type_dict.get(type)
+
+    if type in ["SQLEndpoint", "Warehouse"]:
+        url = f"/v1/workspaces/{workspace_id}/{type_for_url}/{item_id}"
+    else:
+        raise ValueError(
+            f"{icons.red_dot} The type must be 'Warehouse' or 'SQLEndpoint'."
+        )
+
+    return url
+
+
+@log
+def get_sql_audit_settings(
+    item: str | UUID,
+    type: Literal["Warehouse", "SQLEndpoint"],
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
+    """
+    Shows the SQL audit settings of a Fabric item.
+
+    This is a wrapper function for the following API: `SQL Audit Settings - Get SQL Audit Settings <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/get-sql-audit-settings>`_.
+
+    Service Principal Authentication is supported (see `here <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/get-sql-audit-settings#service-principal-authentication>`_).
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The name or ID of the item (Warehouse or SQLEndpoint).
+    type : Literal['Warehouse', 'SQLEndpoint']
+        The type of the item. Must be 'Warehouse' or 'SQLEndpoint'.
+    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 containing the SQL audit settings of the specified warehouse.
+    """
+
+    columns = {
+        "State": "string",
+        "Retention Days": "int",
+        "Audit Actions And Group": "list",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    url = _get_base_url(item=item, type=type, workspace=workspace)
+    response = _base_api(
+        request=f"{url}/settings/sqlAudit",
+        client="fabric_sp",
+    ).json()
+
+    rows = []
+    rows.append(
+        {
+            "State": response.get("state"),
+            "Retention Days": response.get("retentionDays"),
+            "Audit Actions And Group": response.get("auditActionsAndGroups"),
+        }
+    )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def update_sql_audit_settings(
+    item: str | UUID,
+    type: Literal["Warehouse", "SQLEndpoint"],
+    workspace: Optional[str | UUID] = None,
+    retention_days: Optional[int] = None,
+    state: Optional[str] = None,
+):
+    """
+    Update settings associated with the item.
+
+    This is a wrapper function for the following API: SQL Audit Settings - Update SQL Audit Settings <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/update-sql-audit-settings>`_.
+
+    Service Principal Authentication is supported (see `here <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/get-sql-audit-settings#service-principal-authentication>`_).
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The name or ID of the item (Warehouse or SQLEndpoint).
+    type : Literal['Warehouse', 'SQLEndpoint']
+        The type of the item. Must be 'Warehouse' or 'SQLEndpoint'.
+    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)
+
+    payload = {}
+    if retention_days is not None:
+        if not isinstance(retention_days, int) or retention_days < 0:
+            raise ValueError(
+                f"{icons.red_dot} retention_days must be a non-negative integer."
+            )
+        payload["retentionDays"] = retention_days
+    if state is not None:
+        state = state.capitalize()
+        if state not in ["Enabled", "Disabled"]:
+            raise ValueError(
+                f"{icons.red_dot} state must be either 'Enabled' or 'Disabled'."
+            )
+        payload["state"] = state
+
+    if not payload:
+        print(
+            f"{icons.info} No updates were made as neither retention_days nor state were provided."
+        )
+        return
+
+    url = _get_base_url(item=item, type=type, workspace=workspace)
+    _base_api(
+        request=f"{url}/settings/sqlAudit",
+        client="fabric_sp",
+        method="patch",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The SQL audit settings for the '{item}' {type.lower()} within the '{workspace_name}' workspace have been updated accordingly."
+    )
+
+
+@log
+def set_audit_actions_and_group(
+    item: str | UUID,
+    type: Literal["Warehouse", "SQLEndpoint"],
+    sql_audit_groups: List[str],
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Update the audit actions and groups for this item.
+
+    This is a wrapper function for the following API: SQL Audit Settings - Set Audit Actions And Groups <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/set-audit-actions-and-groups>`_.
+
+    Service Principal Authentication is supported (see `here <https://learn.microsoft.com/rest/api/fabric/warehouse/sql-audit-settings/get-sql-audit-settings#service-principal-authentication>`_).
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The name or ID of the item (Warehouse or SQLEndpoint).
+    type : Literal['Warehouse', 'SQLEndpoint']
+        The type of the item. Must be 'Warehouse' or 'SQLEndpoint'.
+    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)
+
+    if (
+        not sql_audit_groups
+        or not isinstance(sql_audit_groups, list)
+        or not all(isinstance(item, str) for item in sql_audit_groups)
+    ):
+        raise ValueError(
+            f"{icons.red_dot} sql_audit_groups must be a non-empty list of strings."
+        )
+
+    url = _get_base_url(item=item, type=type, workspace=workspace)
+    _base_api(
+        request=f"{url}/settings/sqlAudit/setAuditActionsAndGroups",
+        client="fabric_sp",
+        method="post",
+        payload=sql_audit_groups,
+    )
+
+    print(
+        f"{icons.green_dot} The SQL audit actions and groups for the '{item}' {type.lower()} within the '{workspace_name}' workspace have been updated accordingly."
+    )

sempy_labs/_sql_endpoints.py

@@ -66,7 +66,8 @@ def refresh_sql_endpoint_metadata(
     item: str | UUID,
     type: Literal["Lakehouse", "MirroredDatabase"],
     workspace: Optional[str | UUID] = None,
-    tables: dict[str, list[str]] = None,
+    timeout_unit: Literal["Seconds", "Minutes", "Hours", "Days"] = "Minutes",
+    timeout_value: int = 15,
 ) -> pd.DataFrame:
     """
     Refreshes the metadata of a SQL endpoint.
@@ -85,15 +86,10 @@ def refresh_sql_endpoint_metadata(
         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.
-    tables : dict[str, list[str]], default=None
-        A dictionary where the keys are schema names and the values are lists of table names.
-        If empty, all table metadata will be refreshed.
-
-        Example:
-        {
-            "dbo": ["DimDate", "DimGeography"],
-            "sls": ["FactSales", "FactBudget"],
-        }
+    timeout_unit : Literal['Seconds', 'Minutes', 'Hours', 'Days'], default='Minutes'
+        The unit of time for the request duration before timing out. Additional duration types may be added over time.
+    timeout_value : int, default=15
+        The number of time units in the request duration.
 
     Returns
     -------
@@ -132,14 +128,25 @@ def refresh_sql_endpoint_metadata(
     else:
         raise ValueError("Invalid type. Must be 'Lakehouse' or 'MirroredDatabase'.")
 
-    payload = {}
-    if tables:
-        payload = {
-            "tableDefinitions": [
-                {"schema": schema, "tableNames": tables}
-                for schema, tables in tables.items()
-            ]
-        }
+    timeout_unit = timeout_unit.capitalize()
+    if timeout_unit not in ["Seconds", "Minutes", "Hours", "Days"]:
+        raise ValueError(
+            "Invalid timeout_unit. Must be 'Seconds', 'Minutes', 'Hours', or 'Days'."
+        )
+    if timeout_unit == "Hours" and timeout_value > 24:
+        raise ValueError("timeout_value cannot exceed 24 when timeout_unit is 'Hours'.")
+    if timeout_unit == "Days" and timeout_value > 1:
+        raise ValueError("timeout_value cannot exceed 1 when timeout_unit is 'Days'.")
+    if timeout_unit == "Minutes" and timeout_value > 1440:
+        raise ValueError(
+            "timeout_value cannot exceed 1440 when timeout_unit is 'Minutes'."
+        )
+    if timeout_unit == "Seconds" and timeout_value > 86400:
+        raise ValueError(
+            "timeout_value cannot exceed 86400 when timeout_unit is 'Seconds'."
+        )
+
+    payload = {"timeout": {"timeUnit": timeout_unit, "value": timeout_value}}
 
     result = _base_api(
         request=f"v1/workspaces/{workspace_id}/sqlEndpoints/{sql_endpoint_id}/refreshMetadata",
@@ -195,10 +202,8 @@ def refresh_sql_endpoint_metadata(
         df = df[column_order]
 
         printout = f"{icons.green_dot} The metadata of the SQL endpoint for the '{item_name}' {type.lower()} within the '{workspace_name}' workspace has been refreshed"
-        if tables:
-            print(f"{printout} for the following tables: {tables}.")
-        else:
-            print(f"{printout} for all tables.")
+        print(f"{printout} for all tables.")
+        _update_dataframe_datatypes(df, columns)
     else:
         # If the target item has no tables to refresh the metadata for
         df = pd.DataFrame(columns=columns.keys())
@@ -206,6 +211,4 @@ def refresh_sql_endpoint_metadata(
             f"{icons.yellow_dot} The SQL endpoint '{item_name}' {type.lower()} within the '{workspace_name}' workspace has no tables to refresh..."
         )
 
-    _update_dataframe_datatypes(df, columns)
-
     return df

sempy_labs/_utils.py

@@ -66,4 +66,6 @@ items = {
     "DigitalTwinBuilder": "digitaltwinbuilders",
     "DigitalTwinBuilderFlow": "DigitalTwinBuilderFlows",
     "MirroredAzureDatabricksCatalog": "mirroredAzureDatabricksCatalogs",
+    "Map": "Maps",
+    "AnomalyDetector": "anomalydetectors",
 }

sempy_labs/_warehouses.py

@@ -1,5 +1,4 @@
-from ._helper_functions import (
-    resolve_item_id,
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
@@ -233,57 +232,3 @@ def get_warehouse_columns(
         )
 
     return df
-
-
-@log
-def get_warehouse_connection_string(
-    warehouse: str | UUID,
-    workspace: Optional[str | UUID] = None,
-    guest_tenant_id: Optional[UUID] = None,
-    private_link_type: Optional[str] = None,
-) -> str:
-    """
-    Returns the SQL connection string of the specified warehouse.
-
-    Parameters
-    ----------
-    warehouse : str | uuid.UUID
-        Name or ID of the Fabric warehouse.
-    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.
-    guest_tenant_id : uuid.UUID, default=None
-        The guest tenant ID if the end user's tenant is different from the warehouse tenant.
-    private_link_type : str, default=None
-        Indicates the type of private link this connection string uses. Must be either 'Workspace' or 'None' or left as None.
-
-    Returns
-    -------
-    str
-        Returns the SQL connection string of the specified warehouse.
-    """
-    workspace_id = resolve_workspace_id(workspace)
-    warehouse_id = resolve_item_id(
-        item=warehouse, type="Warehouse", workspace=workspace
-    )
-
-    url = f"/v1/workspaces/{workspace_id}/warehouses/{warehouse_id}/connectionString"
-
-    if private_link_type is not None and private_link_type not in ["Workspace", "None"]:
-        raise ValueError(
-            f"{icons.red_dot} private_link_type must be 'Workspace' or 'None' or left as None."
-        )
-
-    if guest_tenant_id or private_link_type:
-        params = []
-        if guest_tenant_id:
-            params.append(f"guestTenantId={guest_tenant_id}")
-        if private_link_type:
-            params.append(f"privateLinkType={private_link_type}")
-        param_str = "?" + "&".join(params)
-        url += param_str
-
-    response = _base_api(request=url, client="fabric_sp")
-
-    return response.json().get("connectionString")

sempy_labs/admin/__init__.py

@@ -98,6 +98,10 @@ from ._sharing_links import (
     remove_all_sharing_links,
     remove_sharing_links,
 )
+from ._labels import (
+    bulk_set_labels,
+    bulk_remove_labels,
+)
 
 __all__ = [
     "list_items",
@@ -161,4 +165,6 @@ __all__ = [
     "rotate_tenant_key",
     "remove_all_sharing_links",
     "remove_sharing_links",
+    "bulk_set_labels",
+    "bulk_remove_labels",
 ]

sempy_labs/admin/_items.py

@@ -2,13 +2,13 @@ import pandas as pd
 from typing import Optional, Tuple
 from uuid import UUID
 import sempy_labs._icons as icons
-from ._basic_functions import (
+from sempy_labs.admin._basic_functions import (
     _resolve_workspace_name_and_id,
 )
-from ._capacities import (
+from sempy_labs.admin._capacities import (
     _resolve_capacity_name_and_id,
 )
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     _is_valid_uuid,
     _build_url,
     _base_api,