semantic-link-labs 0.8.6__py3-none-any.whl → 0.8.8__py3-none-any.whl

sempy_labs/_connections.py

@@ -2,7 +2,131 @@ import sempy.fabric as fabric
 import pandas as pd
 from sempy.fabric.exceptions import FabricHTTPException
 from typing import Optional
-from sempy_labs._helper_functions import pagination
+from sempy_labs._helper_functions import (
+    pagination,
+    _is_valid_uuid,
+)
+from uuid import UUID
+import sempy_labs._icons as icons
+from sempy_labs._gateways import _resolve_gateway_id
+
+
+def delete_connection(connection: str | UUID):
+    """
+    Delete a connection.
+
+    This is a wrapper function for the following API: `Connections - Delete Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/delete-connection>`_.
+
+    Parameters
+    ----------
+    connection : str | UUID
+        The connection name or ID.
+    """
+
+    connection_id = _resolve_connection_id(connection)
+
+    client = fabric.FabricRestClient()
+    response = client.delete(f"/v1/connections/{connection_id}")
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    print(f"{icons.green_dot} The '{connection}' connection has been deleted.")
+
+
+def delete_connection_role_assignment(connection: str | UUID, role_assignment_id: UUID):
+    """
+    Delete the specified role assignment for the connection.
+
+    This is a wrapper function for the following API: `Connections - Delete Connection Role Assignment <https://learn.microsoft.com/rest/api/fabric/core/connections/delete-connection-role-assignment>`_.
+
+    Parameters
+    ----------
+    connection : str | UUID
+        The connection name or ID.
+    role_assignment_id : UUID
+        The role assignment ID.
+    """
+
+    connection_id = _resolve_connection_id(connection)
+
+    client = fabric.FabricRestClient()
+    response = client.delete(
+        f"/v1/connections/{connection_id}/roleAssignments/{role_assignment_id}"
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    print(
+        f"{icons.green_dot} The '{role_assignment_id}' role assignment Id has been deleted from the '{connection}' connection."
+    )
+
+
+def _resolve_connection_id(connection: str | UUID) -> UUID:
+
+    dfC = list_connections()
+    if _is_valid_uuid(connection):
+        dfC_filt = dfC[dfC["Connection Id"] == connection]
+    else:
+        dfC_filt = dfC[dfC["Connection Name"] == connection]
+
+    if len(dfC_filt) == 0:
+        raise ValueError(
+            f"{icons.red_dot} The '{connection}' is not a valid connection."
+        )
+
+    return dfC_filt["Connection Id"].iloc[0]
+
+
+def list_connection_role_assignments(connection: str | UUID) -> pd.DataFrame:
+    """
+    Returns a list of connection role assignments.
+
+    This is a wrapper function for the following API: `Connections - List Connection Role Assignments <https://learn.microsoft.com/rest/api/fabric/core/connections/list-connection-role-assignments>`_.
+
+    Parameters
+    ----------
+    connection : str | UUID
+        The connection name or ID.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of connection role assignments.
+    """
+
+    connection_id = _resolve_connection_id(connection)
+
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/connections/{connection_id}/roleAssignments")
+
+    df = pd.DataFrame(
+        columns=[
+            "Connection Role Assignment Id",
+            "Principal Id",
+            "Principal Type",
+            "Role",
+        ]
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    for r in responses:
+        for v in r.get("value", []):
+            new_data = {
+                "Connection Role Assignment Id": v.get("id"),
+                "Principal Id": v.get("principal", {}).get("id"),
+                "Principal Type": v.get("principal", {}).get("type"),
+                "Role": v.get("role"),
+            }
+
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
 
 
 def list_connections() -> pd.DataFrame:
@@ -21,6 +145,8 @@ def list_connections() -> pd.DataFrame:
     if response.status_code != 200:
         raise FabricHTTPException(response)
 
+    responses = pagination(client, response)
+
     df = pd.DataFrame(
         columns=[
             "Connection Id",
@@ -36,40 +162,42 @@ def list_connections() -> pd.DataFrame:
             "Skip Test Connection",
         ]
     )
+    for r in responses:
+        for i in r.get("value", []):
+            connection_details = i.get("connectionDetails", {})
+            credential_details = i.get("credentialDetails", {})
 
-    for i in response.json().get("value", []):
-        connection_details = i.get("connectionDetails", {})
-        credential_details = i.get("credentialDetails", {})
-
-        new_data = {
-            "Connection Id": i.get("id"),
-            "Connection Name": i.get("displayName"),
-            "Gateway Id": i.get("gatewayId"),
-            "Connectivity Type": i.get("connectivityType"),
-            "Connection Path": connection_details.get("path"),
-            "Connection Type": connection_details.get("type"),
-            "Privacy Level": i.get("privacyLevel"),
-            "Credential Type": (
-                credential_details.get("credentialType") if credential_details else None
-            ),
-            "Single Sign On Type": (
-                credential_details.get("singleSignOnType")
-                if credential_details
-                else None
-            ),
-            "Connection Encryption": (
-                credential_details.get("connectionEncryption")
-                if credential_details
-                else None
-            ),
-            "Skip Test Connection": (
-                credential_details.get("skipTestConnection")
-                if credential_details
-                else None
-            ),
-        }
-
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+            new_data = {
+                "Connection Id": i.get("id"),
+                "Connection Name": i.get("displayName"),
+                "Gateway Id": i.get("gatewayId"),
+                "Connectivity Type": i.get("connectivityType"),
+                "Connection Path": connection_details.get("path"),
+                "Connection Type": connection_details.get("type"),
+                "Privacy Level": i.get("privacyLevel"),
+                "Credential Type": (
+                    credential_details.get("credentialType")
+                    if credential_details
+                    else None
+                ),
+                "Single Sign On Type": (
+                    credential_details.get("singleSignOnType")
+                    if credential_details
+                    else None
+                ),
+                "Connection Encryption": (
+                    credential_details.get("connectionEncryption")
+                    if credential_details
+                    else None
+                ),
+                "Skip Test Connection": (
+                    credential_details.get("skipTestConnection")
+                    if credential_details
+                    else None
+                ),
+            }
+
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
     bool_cols = ["Skip Test Connection"]
     df[bool_cols] = df[bool_cols].astype(bool)
 
@@ -82,6 +210,8 @@ def list_item_connections(
     """
     Shows the list of connections that the specified item is connected to.
 
+    This is a wrapper function for the following API: `Items - List Item Connections <https://learn.microsoft.com/rest/api/fabric/core/items/list-item-connections>`_.
+
     Parameters
     ----------
     item_name : str
@@ -99,8 +229,6 @@ def list_item_connections(
         A pandas dataframe showing the list of connections that the specified item is connected to.
     """
 
-    # https://learn.microsoft.com/en-us/rest/api/fabric/core/items/list-item-connections?tabs=HTTP
-
     workspace = fabric.resolve_workspace_name(workspace)
     workspace_id = fabric.resolve_workspace_id(workspace)
     item_type = item_type[0].upper() + item_type[1:]
@@ -109,7 +237,7 @@ def list_item_connections(
     )
 
     client = fabric.FabricRestClient()
-    response = client.post(f"/v1/workspaces/{workspace_id}/items/{item_id}/connections")
+    response = client.get(f"/v1/workspaces/{workspace_id}/items/{item_id}/connections")
 
     df = pd.DataFrame(
         columns=[
@@ -143,49 +271,115 @@ def list_item_connections(
     return df
 
 
-def create_connection_cloud(
-    name: str,
-    server_name: str,
-    database_name: str,
-    user_name: str,
-    password: str,
-    privacy_level: str,
+def _list_supported_connection_types(
+    gateway: Optional[str | UUID] = None, show_all_creation_methods: bool = False
 ) -> pd.DataFrame:
 
-    # https://review.learn.microsoft.com/en-us/rest/api/fabric/core/connections/create-connection?branch=features%2Fdmts&tabs=HTTP
+    url = f"/v1/connections/supportedConnectionTypes?showAllCreationMethods={show_all_creation_methods}&"
+    if gateway is not None:
+        gateway_id = _resolve_gateway_id(gateway)
+        url += f"gatewayId={gateway_id}"
 
     df = pd.DataFrame(
         columns=[
-            "Connection ID",
-            "Connection Name",
-            "Connectivity Type",
             "Connection Type",
-            "Connection Path",
-            "Privacy Level",
-            "Credential Type",
-            "Single Sign On Type",
-            "Connection Encryption",
-            "Skip Test Connection",
+            "Creation Method",
+            "Supported Credential Types",
+            "Supported Connection Encryption Types",
+            "Supports Skip Test Connection",
         ]
     )
 
+    url = url.rstrip("&")
     client = fabric.FabricRestClient()
+    response = client.get(url)
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    records = []
+    for r in responses:
+        for v in r.get("value", []):
+            records.append(
+                {
+                    "Connection Type": v.get("type"),
+                    "Creation Method": v["creationMethods"][0]["name"],
+                    "Supported Credential Types": v.get("supportedCredentialTypes"),
+                    "Supported Connection Encryption Types": v.get(
+                        "supportedConnectionEncryptionTypes"
+                    ),
+                    "Supports Skip Test Connection": v.get(
+                        "supportsSkipTestConnection"
+                    ),
+                }
+            )
+
+    if records:
+        df = pd.DataFrame(records)
+
+    return df
+
+
+def create_cloud_connection(
+    name: str,
+    server_name: str,
+    database_name: str,
+    user_name: str,
+    password: str,
+    privacy_level: str,
+    connection_encryption: str = "NotEncrypted",
+    skip_test_connection: bool = False,
+):
+    """
+    Creates a shared cloud connection.
+
+    This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
+
+    Parameters
+    ----------
+    name : str
+        The name of the connection.
+    server_name : str
+        The name of the server.
+    database_name : str
+        The name of the database.
+    user_name : str
+        The username.
+    password : str
+        The password.
+    privacy_level : str
+        The `privacy level <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection?tabs=HTTP#privacylevel>`_ of the connection.
+    connection_encryption : str, default="NotEncrypted"
+        The connection encrpytion.
+    skip_test_connection: bool, default=False
+        If True, skips the test connection.
+    """
 
     request_body = {
         "connectivityType": "ShareableCloud",
-        "name": name,
+        "displayName": name,
         "connectionDetails": {
             "type": "SQL",
+            "creationMethod": "SQL",
             "parameters": [
-                {"name": "server", "value": server_name},
-                {"name": "database", "value": database_name},
+                {
+                    "dataType": "Text",
+                    "name": "server",
+                    "value": server_name,
+                },
+                {
+                    "dataType": "Text",
+                    "name": "database",
+                    "value": database_name,
+                },
             ],
         },
         "privacyLevel": privacy_level,
         "credentialDetails": {
             "singleSignOnType": "None",
-            "connectionEncryption": "NotEncrypted",
-            "skipTestConnection": False,
+            "connectionEncryption": connection_encryption,
+            "skipTestConnection": skip_test_connection,
             "credentials": {
                 "credentialType": "Basic",
                 "username": user_name,
@@ -194,77 +388,79 @@ def create_connection_cloud(
         },
     }
 
+    client = fabric.FabricRestClient()
     response = client.post("/v1/connections", json=request_body)
 
-    if response.status_code != 200:
+    if response.status_code != 201:
         raise FabricHTTPException(response)
-    o = response.json()
-    new_data = {
-        "Connection Id": o.get("id"),
-        "Connection Name": o.get("name"),
-        "Connectivity Type": o.get("connectivityType"),
-        "Connection Type": o.get("connectionDetails", {}).get("type"),
-        "Connection Path": o.get("connectionDetails", {}).get("path"),
-        "Privacy Level": o.get("privacyLevel"),
-        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
-        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
-        "Connection Encryption": o.get("credentialDetails", {}).get(
-            "connectionEncryption"
-        ),
-        "Skip Test Connection": o.get("credentialDetails", {}).get(
-            "skipTestConnection"
-        ),
-    }
-    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+    print(f"{icons.green_dot} The '{name}' cloud connection has been created.")
 
-    return df
 
-
-def create_connection_on_prem(
+def create_on_prem_connection(
     name: str,
-    gateway_id: str,
+    gateway: str | UUID,
     server_name: str,
     database_name: str,
     credentials: str,
     privacy_level: str,
-) -> pd.DataFrame:
+    connection_encryption: str = "NotEncrypted",
+    skip_test_connection: bool = False,
+):
+    """
+    Creates an on-premises connection.
 
-    df = pd.DataFrame(
-        columns=[
-            "Connection ID",
-            "Connection Name",
-            "Gateway ID",
-            "Connectivity Type",
-            "Connection Type",
-            "Connection Path",
-            "Privacy Level",
-            "Credential Type",
-            "Single Sign On Type",
-            "Connection Encryption",
-            "Skip Test Connection",
-        ]
-    )
+    This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
 
-    client = fabric.FabricRestClient()
+    Parameters
+    ----------
+    name : str
+        The name of the connection.
+    gateway : str | UUID
+        The name or Id of the gateway.
+    server_name : str
+        The name of the server.
+    database_name : str
+        The name of the database.
+    user_name : str
+        The username.
+    password : str
+        The password.
+    privacy_level : str
+        The `privacy level <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection?tabs=HTTP#privacylevel>`_ of the connection.
+    connection_encryption : str, default="NotEncrypted"
+        The connection encrpytion.
+    skip_test_connection: bool, default=False
+        If True, skips the test connection.
+    """
+
+    gateway_id = _resolve_gateway_id(gateway)
 
     request_body = {
-        "connectivityType": "OnPremisesDataGateway",
+        "connectivityType": "OnPremisesGateway",
         "gatewayId": gateway_id,
-        "name": name,
+        "displayName": name,
         "connectionDetails": {
             "type": "SQL",
+            "creationMethod": "SQL",
             "parameters": [
-                {"name": "server", "value": server_name},
-                {"name": "database", "value": database_name},
+                {
+                    "dataType": "Text",
+                    "name": "server",
+                    "value": server_name,
+                },
+                {
+                    "dataType": "Text",
+                    "name": "database",
+                    "value": database_name,
+                },
             ],
         },
         "privacyLevel": privacy_level,
         "credentialDetails": {
             "singleSignOnType": "None",
-            "connectionEncryption": "NotEncrypted",
-            "skipTestConnection": False,
+            "connectionEncryption": connection_encryption,
+            "skipTestConnection": skip_test_connection,
             "credentials": {
                 "credentialType": "Windows",
                 "values": [{"gatewayId": gateway_id, "credentials": credentials}],
@@ -272,79 +468,80 @@ def create_connection_on_prem(
         },
     }
 
+    client = fabric.FabricRestClient()
     response = client.post("/v1/connections", json=request_body)
 
-    if response.status_code != 200:
+    if response.status_code != 201:
         raise FabricHTTPException(response)
-    o = response.json()
-    new_data = {
-        "Connection Id": o.get("id"),
-        "Connection Name": o.get("name"),
-        "Gateway ID": o.get("gatewayId"),
-        "Connectivity Type": o.get("connectivityType"),
-        "Connection Type": o.get("connectionDetails", {}).get("type"),
-        "Connection Path": o.get("connectionDetails", {}).get("path"),
-        "Privacy Level": o.get("privacyLevel"),
-        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
-        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
-        "Connection Encryption": o.get("credentialDetails", {}).get(
-            "connectionEncryption"
-        ),
-        "Skip Test Connection": o.get("credentialDetails", {}).get(
-            "skipTestConnection"
-        ),
-    }
-    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-    return df
+    print(f"{icons.green_dot} The '{name}' on-prem connection has been created.")
 
 
-def create_connection_vnet(
+def create_vnet_connection(
     name: str,
-    gateway_id: str,
+    gateway: str | UUID,
     server_name: str,
     database_name: str,
     user_name: str,
     password: str,
     privacy_level: str,
-) -> pd.DataFrame:
+    connection_encryption: Optional[str] = "NotEncrypted",
+    skip_test_connection: bool = False,
+):
+    """
+    Creates a virtual network gateway connection.
 
-    df = pd.DataFrame(
-        columns=[
-            "Connection ID",
-            "Connection Name",
-            "Gateway ID",
-            "Connectivity Type",
-            "Connection Type",
-            "Connection Path",
-            "Privacy Level",
-            "Credential Type",
-            "Single Sign On Type",
-            "Connection Encryption",
-            "Skip Test Connection",
-        ]
-    )
+    This is a wrapper function for the following API: `Connections - Create Connection <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection>`_.
 
-    client = fabric.FabricRestClient()
+    Parameters
+    ----------
+    name : str
+        The name of the connection.
+    gateway : str | UUID
+        The name or Id of the gateway.
+    server_name : str
+        The name of the server.
+    database_name : str
+        The name of the database.
+    user_name : str
+        The username.
+    password : str
+        The password.
+    privacy_level : str
+        The `privacy level <https://learn.microsoft.com/rest/api/fabric/core/connections/create-connection?tabs=HTTP#privacylevel>`_ of the connection.
+    connection_encryption : str, default="NotEncrypted"
+        The connection encrpytion.
+    skip_test_connection: bool, default=False
+        If True, skips the test connection.
+    """
+
+    gateway_id = _resolve_gateway_id(gateway)
 
     request_body = {
-        "connectivityType": "VirtualNetworkDataGateway",
+        "connectivityType": "VirtualNetworkGateway",
         "gatewayId": gateway_id,
-        "name": name,
+        "displayName": name,
         "connectionDetails": {
             "type": "SQL",
+            "creationMethod": "SQL",
             "parameters": [
-                {"name": "server", "value": server_name},
-                {"name": "database", "value": database_name},
+                {
+                    "dataType": "Text",
+                    "name": "server",
+                    "value": server_name,
+                },
+                {
+                    "dataType": "Text",
+                    "name": "database",
+                    "value": database_name,
+                },
             ],
         },
         "privacyLevel": privacy_level,
         "credentialDetails": {
             "singleSignOnType": "None",
-            "connectionEncryption": "Encrypted",
-            "skipTestConnection": False,
+            "connectionEncryption": connection_encryption,
+            "skipTestConnection": skip_test_connection,
             "credentials": {
                 "credentialType": "Basic",
                 "username": user_name,
@@ -353,30 +550,12 @@ def create_connection_vnet(
         },
     }
 
+    client = fabric.FabricRestClient()
     response = client.post("/v1/connections", json=request_body)
 
-    if response.status_code != 200:
+    if response.status_code != 201:
         raise FabricHTTPException(response)
-    o = response.json()
-    new_data = {
-        "Connection Id": o.get("id"),
-        "Connection Name": o.get("name"),
-        "Gateway ID": o.get("gatewayId"),
-        "Connectivity Type": o.get("connectivityType"),
-        "Connection Type": o.get("connectionDetails", {}).get("type"),
-        "Connection Path": o.get("connectionDetails", {}).get("path"),
-        "Privacy Level": o.get("privacyLevel"),
-        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
-        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
-        "Connection Encryption": o.get("credentialDetails", {}).get(
-            "connectionEncryption"
-        ),
-        "Skip Test Connection": o.get("credentialDetails", {}).get(
-            "skipTestConnection"
-        ),
-    }
-    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-    return df
+    print(
+        f"{icons.green_dot} The '{name}' virtual network gateway connection has been created."
+    )

sempy_labs/_dataflows.py

@@ -153,7 +153,6 @@ def list_upstream_dataflows(
         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