semantic-link-labs 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

sempy_labs/admin/_domains.py

@@ -1,37 +1,85 @@
-import sempy.fabric as fabric
 from typing import Optional, List
 import sempy_labs._icons as icons
-from sempy_labs._helper_functions import lro
-from sempy.fabric.exceptions import FabricHTTPException
 import pandas as pd
 from uuid import UUID
 from sempy_labs.admin._basic_functions import list_workspaces
-import sempy_labs._authentication as auth
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    _is_valid_uuid,
+)
 
 
-def resolve_domain_id(domain_name: str) -> UUID:
+def resolve_domain_id(domain: Optional[str | UUID] = None, **kwargs) -> UUID:
     """
     Obtains the domain Id for a given domain name.
 
     Parameters
     ----------
-    domain_name : str
-        The domain name
+    domain_name : str | uuid.UUID
+        The domain name or ID
 
     Returns
     -------
-    UUID
+    uuid.UUID
         The domain Id.
     """
 
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
+
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
+
+    if _is_valid_uuid(domain):
+        return domain
+
     dfL = list_domains()
-    dfL_filt = dfL[dfL["Domain Name"] == domain_name]
-    if len(dfL_filt) == 0:
-        raise ValueError(f"{icons.red_dot} '{domain_name}' is not a valid domain name.")
+    dfL_filt = dfL[dfL["Domain Name"] == domain]
+    if dfL_filt.empty:
+        raise ValueError(f"{icons.red_dot} '{domain}' is not a valid domain name.")
 
     return dfL_filt["Domain ID"].iloc[0]
 
 
+def resolve_domain_name(domain: Optional[str | UUID], **kwargs) -> UUID:
+    """
+    Obtains the domain name for a given domain ID.
+
+    Parameters
+    ----------
+    domain : str | uuid.UUID
+        The domain name or ID
+
+    Returns
+    -------
+    str
+        The domain Name.
+    """
+
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
+
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
+
+    if not _is_valid_uuid(domain):
+        return domain
+
+    dfL = list_domains()
+    dfL_filt = dfL[dfL["Domain ID"] == domain]
+    if dfL_filt.empty:
+        raise ValueError(f"{icons.red_dot} '{domain}' is not a valid domain name.")
+
+    return dfL_filt["Domain Name"].iloc[0]
+
+
 def list_domains(non_empty_only: bool = False) -> pd.DataFrame:
     """
     Shows a list of domains.
@@ -52,24 +100,20 @@ def list_domains(non_empty_only: bool = False) -> pd.DataFrame:
         A pandas dataframe showing a list of the domains.
     """
 
-    df = pd.DataFrame(
-        columns=[
-            "Domain ID",
-            "Domain Name",
-            "Description",
-            "Parent Domain ID",
-            "Contributors Scope",
-        ]
-    )
+    columns = {
+        "Domain ID": "string",
+        "Domain Name": "string",
+        "Description": "string",
+        "Parent Domain ID": "string",
+        "Contributors Scope": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
-    client = fabric.FabricRestClient(token_provider=auth.token_provider.get())
     url = "/v1/admin/domains"
     if non_empty_only:
         url = f"{url}?nonEmptyOnly=True"
-    response = client.get(url)
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    response = _base_api(request=url, client="fabric_sp")
 
     for v in response.json().get("domains", []):
         new_data = {
@@ -84,7 +128,7 @@ def list_domains(non_empty_only: bool = False) -> pd.DataFrame:
     return df
 
 
-def list_domain_workspaces(domain_name: str) -> pd.DataFrame:
+def list_domain_workspaces(domain: Optional[str] = None, **kwargs) -> pd.DataFrame:
     """
     Shows a list of workspaces within the domain.
 
@@ -94,8 +138,8 @@ def list_domain_workspaces(domain_name: str) -> pd.DataFrame:
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
 
     Returns
     -------
@@ -103,15 +147,26 @@ def list_domain_workspaces(domain_name: str) -> pd.DataFrame:
         A pandas dataframe showing a list of workspaces within the domain.
     """
 
-    domain_id = resolve_domain_id(domain_name)
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
+
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
 
-    df = pd.DataFrame(columns=["Workspace ID", "Workspace Name"])
+    domain_id = resolve_domain_id(domain)
 
-    client = fabric.FabricRestClient(token_provider=auth.token_provider.get())
-    response = client.get(f"/v1/admin/domains/{domain_id}/workspaces")
+    columns = {
+        "Workspace ID": "string",
+        "Workspace Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    response = _base_api(
+        request=f"/v1/admin/domains/{domain_id}/workspaces", client="fabric_sp"
+    )
 
     for v in response.json().get("value", []):
         new_data = {
@@ -126,7 +181,8 @@ def list_domain_workspaces(domain_name: str) -> pd.DataFrame:
 def create_domain(
     domain_name: str,
     description: Optional[str] = None,
-    parent_domain_name: Optional[str] = None,
+    parent_domain: Optional[str | UUID] = None,
+    **kwargs,
 ):
     """
     Creates a new domain.
@@ -139,30 +195,34 @@ def create_domain(
         The domain name.
     description : str, default=None
         The domain description.
-    parent_domain_name : str, default=None
-        The parent domain name.
+    parent_domain : str | uuid.UUID, default=None
+        The parent domain name or ID.
     """
 
-    if parent_domain_name is not None:
-        parent_domain_id = resolve_domain_id(parent_domain_name)
+    if "parent_domain_name" in kwargs:
+        parent_domain = kwargs["parent_domain_name"]
+        print(
+            f"{icons.warning} The 'parent_domain_name' parameter is deprecated. Please use 'parent_domain' instead."
+        )
+
+    if parent_domain is not None:
+        parent_domain_id = resolve_domain_id(domain=parent_domain)
 
     payload = {}
     payload["displayName"] = domain_name
     if description is not None:
         payload["description"] = description
-    if parent_domain_name is not None:
+    if parent_domain is not None:
         payload["parentDomainId"] = parent_domain_id
 
-    client = fabric.FabricRestClient()
-    response = client.post("/v1/admin/domains", json=payload)
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
+    _base_api(
+        request="/v1/admin/domains", method="post", payload=payload, status_codes=201
+    )
 
     print(f"{icons.green_dot} The '{domain_name}' domain has been created.")
 
 
-def delete_domain(domain_name: str):
+def delete_domain(domain: Optional[str | UUID], **kwargs):
     """
     Deletes a domain.
 
@@ -170,25 +230,30 @@ def delete_domain(domain_name: str):
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     """
 
-    domain_id = resolve_domain_id(domain_name)
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
 
-    client = fabric.FabricRestClient()
-    response = client.delete(f"/v1/admin/domains/{domain_id}")
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    domain_id = resolve_domain_id(domain)
+    _base_api(request=f"/v1/admin/domains/{domain_id}", method="delete")
 
-    print(f"{icons.green_dot} The '{domain_name}' domain has been deleted.")
+    print(f"{icons.green_dot} The '{domain}' domain has been deleted.")
 
 
 def update_domain(
-    domain_name: str,
+    domain: Optional[str | UUID] = None,
     description: Optional[str] = None,
     contributors_scope: Optional[str] = None,
+    **kwargs,
 ):
     """
     Updates a domain's properties.
@@ -197,14 +262,22 @@ def update_domain(
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     description : str, default=None
         The domain description.
     contributors_scope : str, default=None
         The domain `contributor scope <https://learn.microsoft.com/rest/api/fabric/admin/domains/update-domain?tabs=HTTP#contributorsscopetype>`_.
     """
 
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
+
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
     contributors_scopes = ["AdminsOnly", "AllTenant", "SpecificUsersAndGroups"]
 
     if contributors_scope not in contributors_scopes:
@@ -212,7 +285,8 @@ def update_domain(
             f"{icons.red_dot} Invalid contributors scope. Valid options: {contributors_scopes}."
         )
 
-    domain_id = resolve_domain_id(domain_name)
+    domain_id = resolve_domain_id(domain)
+    domain_name = resolve_domain_name(domain)
 
     payload = {}
     payload["displayName"] = domain_name
@@ -222,17 +296,15 @@ def update_domain(
     if contributors_scope is not None:
         payload["contributorsScope"] = contributors_scope
 
-    client = fabric.FabricRestClient()
-    response = client.patch(f"/v1/admin/domains/{domain_id}", json=payload)
-
-    if response != 200:
-        raise FabricHTTPException(response)
+    _base_api(request=f"/v1/admin/domains/{domain_id}", method="patch", payload=payload)
 
     print(f"{icons.green_dot} The '{domain_name}' domain has been updated.")
 
 
 def assign_domain_workspaces_by_capacities(
-    domain_name: str, capacity_names: str | List[str]
+    domain: str | UUID,
+    capacity_names: str | List[str],
+    **kwargs,
 ):
     """
     Assigns all workspaces that reside on the specified capacities to the specified domain.
@@ -241,15 +313,23 @@ def assign_domain_workspaces_by_capacities(
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     capacity_names : str | List[str]
         The capacity names.
     """
 
     from sempy_labs.admin import list_capacities
 
-    domain_id = resolve_domain_id(domain_name)
+    if "domain_name" in kwargs:
+        domain = kwargs["domain_name"]
+        print(
+            f"{icons.warning} The 'domain_name' parameter is deprecated. Please use 'domain' instead."
+        )
+
+    if domain is None:
+        raise ValueError(f"{icons.red_dot} Please provide a domain.")
+    domain_id = resolve_domain_id(domain)
 
     if isinstance(capacity_names, str):
         capacity_names = [capacity_names]
@@ -276,20 +356,20 @@ def assign_domain_workspaces_by_capacities(
 
     payload = {"capacitiesIds": capacity_list}
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/admin/domains/{domain_id}/assignWorkspacesByCapacities",
-        json=payload,
+    _base_api(
+        request=f"/v1/admin/domains/{domain_id}/assignWorkspacesByCapacities",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=202,
     )
 
-    lro(client, response)
-
     print(
-        f"{icons.green_dot} The workspaces in the {capacity_names} capacities have been assigned to the '{domain_name}' domain."
+        f"{icons.green_dot} The workspaces in the {capacity_names} capacities have been assigned to the '{domain}' domain."
     )
 
 
-def assign_domain_workspaces(domain_name: str, workspace_names: str | List[str]):
+def assign_domain_workspaces(domain: str | UUID, workspace_names: str | List[str]):
     """
     Assigns workspaces to the specified domain by workspace.
 
@@ -297,13 +377,13 @@ def assign_domain_workspaces(domain_name: str, workspace_names: str | List[str])
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     workspace_names : str | List[str]
         The Fabric workspace(s).
     """
 
-    domain_id = resolve_domain_id(domain_name=domain_name)
+    domain_id = resolve_domain_id(domain)
 
     if isinstance(workspace_names, str):
         workspace_names = [workspace_names]
@@ -329,20 +409,20 @@ def assign_domain_workspaces(domain_name: str, workspace_names: str | List[str])
 
     payload = {"workspacesIds": workspace_list}
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/admin/domains/{domain_id}/assignWorkspaces",
-        json=payload,
+    _base_api(
+        request=f"/v1/admin/domains/{domain_id}/assignWorkspaces",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=200,
     )
 
-    lro(client, response)
-
     print(
-        f"{icons.green_dot} The {workspace_names} workspaces have been assigned to the '{domain_name}' domain."
+        f"{icons.green_dot} The {workspace_names} workspaces have been assigned to the '{domain}' domain."
     )
 
 
-def unassign_all_domain_workspaces(domain_name: str):
+def unassign_all_domain_workspaces(domain: str | UUID):
     """
     Unassigns all workspaces from the specified domain.
 
@@ -350,23 +430,28 @@ def unassign_all_domain_workspaces(domain_name: str):
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     """
 
-    domain_id = resolve_domain_id(domain_name=domain_name)
+    domain_id = resolve_domain_id(domain)
 
-    client = fabric.FabricRestClient()
-    response = client.post(f"/v1/admin/domains/{domain_id}/unassignAllWorkspaces")
+    _base_api(
+        request=f"/v1/admin/domains/{domain_id}/unassignAllWorkspaces",
+        method="post",
+        lro_return_status_code=True,
+        status_codes=200,
+    )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
     print(
-        f"{icons.green_dot} All workspaces assigned to the '{domain_name}' domain have been unassigned."
+        f"{icons.green_dot} All workspaces assigned to the '{domain}' domain have been unassigned."
     )
 
 
-def unassign_domain_workspaces(domain_name: str, workspace_names: str | List[str]):
+def unassign_domain_workspaces(
+    domain: str | UUID,
+    workspace_names: str | List[str],
+):
     """
     Unassigns workspaces from the specified domain by workspace.
 
@@ -374,13 +459,13 @@ def unassign_domain_workspaces(domain_name: str, workspace_names: str | List[str
 
     Parameters
     ----------
-    domain_name : str
-        The domain name.
+    domain : str | uuid.UUID
+        The domain name or ID.
     workspace_names : str | List[str]
         The Fabric workspace(s).
     """
 
-    domain_id = resolve_domain_id(domain_name=domain_name)
+    domain_id = resolve_domain_id(domain)
 
     if isinstance(workspace_names, str):
         workspace_names = [workspace_names]
@@ -405,13 +490,13 @@ def unassign_domain_workspaces(domain_name: str, workspace_names: str | List[str
     workspace_list = list(dfW_filt["Id"])
 
     payload = {"workspacesIds": workspace_list}
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/admin/domains/{domain_id}/unassignWorkspaces", json=payload
+
+    _base_api(
+        request=f"/v1/admin/domains/{domain_id}/unassignWorkspaces",
+        method="post",
+        payload=payload,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
     print(
-        f"{icons.green_dot} The {workspace_names} workspaces assigned to the '{domain_name}' domain have been unassigned."
+        f"{icons.green_dot} The {workspace_names} workspaces assigned to the '{domain}' domain have been unassigned."
     )

sempy_labs/admin/_external_data_share.py

@@ -1,9 +1,12 @@
-import sempy.fabric as fabric
 from uuid import UUID
 import sempy_labs._icons as icons
-from sempy.fabric.exceptions import FabricHTTPException
 import pandas as pd
 from sempy_labs.admin._basic_functions import _resolve_workspace_name_and_id
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+)
 
 
 def list_external_data_shares() -> pd.DataFrame:
@@ -17,28 +20,24 @@ def list_external_data_shares() -> pd.DataFrame:
     pandas.DataFrame
         A pandas dataframe showing a list of external data shares in the tenant.
     """
-    df = pd.DataFrame(
-        columns=[
-            "External Data Share Id",
-            "Paths",
-            "Creater Principal Id",
-            "Creater Principal Name",
-            "Creater Principal Type",
-            "Creater Principal UPN",
-            "Recipient UPN",
-            "Status",
-            "Expiration Time UTC",
-            "Workspace Id",
-            "Item Id",
-            "Invitation URL",
-        ]
-    )
-
-    client = fabric.FabricRestClient()
-    response = client.get("/v1/admin/items/externalDataShares")
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
+    columns = {
+        "External Data Share Id": "string",
+        "Paths": "string",
+        "Creater Principal Id": "string",
+        "Creater Principal Name": "string",
+        "Creater Principal Type": "string",
+        "Creater Principal UPN": "string",
+        "Recipient UPN": "string",
+        "Status": "string",
+        "Expiration Time UTC": "datetime",
+        "Workspace Id": "string",
+        "Item Id": "string",
+        "Invitation URL": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    response = _base_api(request="/v1/admin/items/externalDataShares")
 
     for i in response.json().get("value", []):
         cp = i.get("creatorPrincipal", {})
@@ -59,8 +58,7 @@ def list_external_data_shares() -> pd.DataFrame:
 
         df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    date_time_columns = ["Expiration Time UTC"]
-    df[date_time_columns] = pd.to_datetime(df[date_time_columns])
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
@@ -84,14 +82,11 @@ def revoke_external_data_share(
     """
     (workspace, workspace_id) = _resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/admin/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke"
+    _base_api(
+        request=f"/v1/admin/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke",
+        method="post",
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} The '{external_data_share_id}' external data share for the '{item_id}' item within the '{workspace}' workspace has been revoked."
     )

sempy_labs/admin/_git.py

@@ -1,11 +1,9 @@
-import sempy.fabric as fabric
-from sempy.fabric.exceptions import FabricHTTPException
 from sempy_labs._helper_functions import (
-    pagination,
+    _base_api,
+    _create_dataframe,
 )
 import pandas as pd
 from sempy_labs.admin._basic_functions import list_workspaces
-import sempy_labs._authentication as auth
 
 
 def list_git_connections() -> pd.DataFrame:
@@ -22,27 +20,24 @@ def list_git_connections() -> pd.DataFrame:
         A pandas dataframe showing a list of Git connections.
     """
 
-    client = fabric.FabricRestClient(token_provider=auth.token_provider.get())
-    response = client.get("/v1/admin/workspaces/discoverGitConnections")
+    columns = {
+        "Workspace Id": "string",
+        "Organization Name": "string",
+        "Owner Name": "string",
+        "Project Name": "string",
+        "Git Provider Type": "string",
+        "Repository Name": "string",
+        "Branch Name": "string",
+        "Directory Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
-    df = pd.DataFrame(
-        columns=[
-            "Workspace Id",
-            "Organization Name",
-            "Owner Name",
-            "Project Name",
-            "Git Provider Type",
-            "Repository Name",
-            "Branch Name",
-            "Directory Name",
-        ]
+    responses = _base_api(
+        request="/v1/admin/workspaces/discoverGitConnections",
+        client="fabric_sp",
+        uses_pagination=True,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
     for r in responses:
         for v in r.get("value", []):
             git = v.get("gitProviderDetails", {})