msfabricpysdkcore 0.0.11__tar.gz → 0.0.13__tar.gz

{msfabricpysdkcore-0.0.11 → msfabricpysdkcore-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.11
+Version: 0.0.13
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core
@@ -38,14 +38,17 @@ Currently it supports all Core APIs, Admin APIs, Lakehouse APIs and all other it
 - Core APIs
   - [Capacities](#working-with-capacities)
   - [Deployment Pipelines](#deployment-pipelines)
+  - [External Data Shares](#external-data-shares)
   - [Git](#working-with-git)
   - [Items](#working-with-items)
   - [Job Scheduler](#working-with-job-scheduler)
   - [Long Running Operations](#long-running-operations)
+  - [OneLakeDataAccessSecurity](#one-lake-data-access-security)
   - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
   - [Workspaces](#working-with-workspaces)
 - Admin APIs
   - [Domains](#admin-api-for-domains)
+  - [External Data Shares](#admin-api-for-external-data-shares)
   - [Items](#admin-api-for-items)
   - [Labels](#admin-api-for-labels)
   - [Tenants](#admin-api-for-tenants)
@@ -148,26 +151,40 @@ ws.add_role_assignment(principal = {"id" : "abadfbafb",
                        role = 'Member')
 
  
- # Get workspace role assignments
-fc.get_workspace_role_assignments(workspace_id = ws.id)
+ # List workspace role assignments
+fc.list_workspace_role_assignments(workspace_id = ws.id)
 # or
-ws.get_role_assignments()
+ws.list_role_assignments()
 
 
+# Get workspace role assignment
+fc.get_workspace_role_assignment(workspace_id = ws.id, 
+                                 workspace_role_assignment_id = "dagdasf")  
+# or
+ws.get_role_assignment(workspace_role_assignment_id = "fsgdg")
+
 # Update workspace role assignment
 fc.update_workspace_role_assignment(workspace_id = ws.id, 
                                     role = "Contributor", 
-                                    principal_id = "abadfbafb")
+                                    workspace_role_assignment_id = "abadfbafb")
 # or
 ws.update_role_assignment(role = "Contributor", 
-                          principal_id = "abadfbafb")
+                          workspace_role_assignment_id = "abadfbafb")
 
 
 # Delete workspace role assignment
 fc.delete_workspace_role_assignment(workspace_id = ws.id,
-                                    principal_id = "abadfbafb")
+                                    workspace_role_assignment_id = "abadfbafb")
 # or
-ws.delete_role_assignment(principal_id = "abadfbafb")
+ws.delete_role_assignment(workspace_role_assignment_id = "abadfbafb")
+
+
+# Provision Identity
+result = fc.provision_identity(workspace_id=ws.id)
+print(result["applicationId"]))
+
+# Deprovision Identity
+fc.deprovision_identity(workspace_id=ws.id)
 
 ```
 
@@ -235,6 +252,43 @@ response = pipe.deploy(source_stage_id=dev_stage.id,target_stage_id=prod_stage.i
 
 ```
 
+### External Data Shares
+
+```python
+from msfabricpysdkcore.coreapi import FabricClientCore
+
+fc = FabricClientCore()
+
+workspace_id = 'yxcvyxcvyxcv'
+item_id = 'sdfsdfsdfsf'
+
+
+# Create
+
+recipient = {
+    "userPrincipalName": "lisa4@fabrikam.com"
+}
+paths=["Files/external"]
+
+data_share = fc.create_external_data_share(workspace_id, item_id, paths, recipient)
+
+# Get
+
+data_share2 = fc.get_external_data_share(workspace_id, item_id, data_share['id'])
+
+# List
+
+data_share_list = fc.list_external_data_shares_in_item(workspace_id, item_id)
+
+data_share_ids = [ds['id'] for ds in data_share_list]
+
+# Revoke
+
+response_code = fc.revoke_external_data_share(workspace_id, item_id, data_share['id'])
+
+```
+
+
 ### Working with items
 
 ```python
@@ -438,6 +492,44 @@ results = fc.get_operation_results(operation_id)
 
 ```
 
+### One Lake Data Access Security
+
+```python
+from msfabricpysdkcore import FabricClientCore
+
+fc = FabricClientCore() 
+
+workspace_id = "d8aafgasdsdbe5"
+item_id = "503hsdfhs48364"
+
+# List 
+
+resp = fc.list_data_access_roles(workspace_id=workspace_id, item_id=item_id)
+
+roles = resp[0]
+etag = resp[1]
+
+
+# Create or Update
+
+role1 = roles[1]
+
+item_access = role1["members"]["fabricItemMembers"][0]['itemAccess']
++
+if 'ReadAll' in item_access:
+    item_access = ['Read', 'Write', 'Execute']
+else:
+    item_access.append('ReadAll')
+
+role1["members"]["fabricItemMembers"][0]['itemAccess'] = item_access
+roles[1] = role1
+
+resp = fc.create_or_update_data_access_roles(workspace_id=workspace_id, 
+                                              item_id=item_id, 
+                                              data_access_roles=roles, 
+                                              etag_match={"If-Match":etag})
+
+```
 
 ### Admin API for Workspaces
 
@@ -597,6 +689,29 @@ status_code = fca.role_assignments_bulk_unassign(domain.id, "Contributors", [pri
 status_code = fca.delete_domain(domain.id)
 ```
 
+### Admin API for External Data Shares
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# List external data shares
+
+data_shares = fca.list_external_data_shares()
+ws = fca.list_workspaces(name="testworkspace")[0]
+
+data_shares = [d for d in data_shares if d['workspaceId'] == ws.id]
+
+# Revoke external data share
+
+fca.revoke_external_data_share(external_data_share_id = data_shares[0]['id'], 
+                                item_id = data_shares[0]['itemId'], 
+                                workspace_id = data_shares[0]['workspaceId'])
+
+
+```
+
 
 Note: This SDK is not an official SDK from Microsoft. It is a community project and not supported by Microsoft. Use it at your own risk.
 Also the API is still in preview and might change. This SDK is not yet feature complete and might not cover all APIs yet. Feel free to contribute to this project to make it better.

{msfabricpysdkcore-0.0.11 → msfabricpysdkcore-0.0.13}/README.md

@@ -23,14 +23,17 @@ Currently it supports all Core APIs, Admin APIs, Lakehouse APIs and all other it
 - Core APIs
   - [Capacities](#working-with-capacities)
   - [Deployment Pipelines](#deployment-pipelines)
+  - [External Data Shares](#external-data-shares)
   - [Git](#working-with-git)
   - [Items](#working-with-items)
   - [Job Scheduler](#working-with-job-scheduler)
   - [Long Running Operations](#long-running-operations)
+  - [OneLakeDataAccessSecurity](#one-lake-data-access-security)
   - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
   - [Workspaces](#working-with-workspaces)
 - Admin APIs
   - [Domains](#admin-api-for-domains)
+  - [External Data Shares](#admin-api-for-external-data-shares)
   - [Items](#admin-api-for-items)
   - [Labels](#admin-api-for-labels)
   - [Tenants](#admin-api-for-tenants)
@@ -133,26 +136,40 @@ ws.add_role_assignment(principal = {"id" : "abadfbafb",
                        role = 'Member')
 
  
- # Get workspace role assignments
-fc.get_workspace_role_assignments(workspace_id = ws.id)
+ # List workspace role assignments
+fc.list_workspace_role_assignments(workspace_id = ws.id)
 # or
-ws.get_role_assignments()
+ws.list_role_assignments()
 
 
+# Get workspace role assignment
+fc.get_workspace_role_assignment(workspace_id = ws.id, 
+                                 workspace_role_assignment_id = "dagdasf")  
+# or
+ws.get_role_assignment(workspace_role_assignment_id = "fsgdg")
+
 # Update workspace role assignment
 fc.update_workspace_role_assignment(workspace_id = ws.id, 
                                     role = "Contributor", 
-                                    principal_id = "abadfbafb")
+                                    workspace_role_assignment_id = "abadfbafb")
 # or
 ws.update_role_assignment(role = "Contributor", 
-                          principal_id = "abadfbafb")
+                          workspace_role_assignment_id = "abadfbafb")
 
 
 # Delete workspace role assignment
 fc.delete_workspace_role_assignment(workspace_id = ws.id,
-                                    principal_id = "abadfbafb")
+                                    workspace_role_assignment_id = "abadfbafb")
 # or
-ws.delete_role_assignment(principal_id = "abadfbafb")
+ws.delete_role_assignment(workspace_role_assignment_id = "abadfbafb")
+
+
+# Provision Identity
+result = fc.provision_identity(workspace_id=ws.id)
+print(result["applicationId"]))
+
+# Deprovision Identity
+fc.deprovision_identity(workspace_id=ws.id)
 
 ```
 
@@ -220,6 +237,43 @@ response = pipe.deploy(source_stage_id=dev_stage.id,target_stage_id=prod_stage.i
 
 ```
 
+### External Data Shares
+
+```python
+from msfabricpysdkcore.coreapi import FabricClientCore
+
+fc = FabricClientCore()
+
+workspace_id = 'yxcvyxcvyxcv'
+item_id = 'sdfsdfsdfsf'
+
+
+# Create
+
+recipient = {
+    "userPrincipalName": "lisa4@fabrikam.com"
+}
+paths=["Files/external"]
+
+data_share = fc.create_external_data_share(workspace_id, item_id, paths, recipient)
+
+# Get
+
+data_share2 = fc.get_external_data_share(workspace_id, item_id, data_share['id'])
+
+# List
+
+data_share_list = fc.list_external_data_shares_in_item(workspace_id, item_id)
+
+data_share_ids = [ds['id'] for ds in data_share_list]
+
+# Revoke
+
+response_code = fc.revoke_external_data_share(workspace_id, item_id, data_share['id'])
+
+```
+
+
 ### Working with items
 
 ```python
@@ -423,6 +477,44 @@ results = fc.get_operation_results(operation_id)
 
 ```
 
+### One Lake Data Access Security
+
+```python
+from msfabricpysdkcore import FabricClientCore
+
+fc = FabricClientCore() 
+
+workspace_id = "d8aafgasdsdbe5"
+item_id = "503hsdfhs48364"
+
+# List 
+
+resp = fc.list_data_access_roles(workspace_id=workspace_id, item_id=item_id)
+
+roles = resp[0]
+etag = resp[1]
+
+
+# Create or Update
+
+role1 = roles[1]
+
+item_access = role1["members"]["fabricItemMembers"][0]['itemAccess']
++
+if 'ReadAll' in item_access:
+    item_access = ['Read', 'Write', 'Execute']
+else:
+    item_access.append('ReadAll')
+
+role1["members"]["fabricItemMembers"][0]['itemAccess'] = item_access
+roles[1] = role1
+
+resp = fc.create_or_update_data_access_roles(workspace_id=workspace_id, 
+                                              item_id=item_id, 
+                                              data_access_roles=roles, 
+                                              etag_match={"If-Match":etag})
+
+```
 
 ### Admin API for Workspaces
 
@@ -582,6 +674,29 @@ status_code = fca.role_assignments_bulk_unassign(domain.id, "Contributors", [pri
 status_code = fca.delete_domain(domain.id)
 ```
 
+### Admin API for External Data Shares
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# List external data shares
+
+data_shares = fca.list_external_data_shares()
+ws = fca.list_workspaces(name="testworkspace")[0]
+
+data_shares = [d for d in data_shares if d['workspaceId'] == ws.id]
+
+# Revoke external data share
+
+fca.revoke_external_data_share(external_data_share_id = data_shares[0]['id'], 
+                                item_id = data_shares[0]['itemId'], 
+                                workspace_id = data_shares[0]['workspaceId'])
+
+
+```
+
 
 Note: This SDK is not an official SDK from Microsoft. It is a community project and not supported by Microsoft. Use it at your own risk.
 Also the API is still in preview and might change. This SDK is not yet feature complete and might not cover all APIs yet. Feel free to contribute to this project to make it better.

{msfabricpysdkcore-0.0.11 → msfabricpysdkcore-0.0.13}/msfabricpysdkcore/adminapi.py

@@ -658,4 +658,52 @@ class FabricClientAdmin(FabricClient):
             break
 
         response = json.loads(response.text)
-        return response
+        return response
+    
+    def list_external_data_shares(self, continuationToken = None):
+        # GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares
+        """List external data shares
+        
+        Returns:
+            list: The list of external data shares
+        """
+        url = "https://api.fabric.microsoft.com/v1/admin/items/externalDataShares"
+
+        if continuationToken:
+            url = f"{url}?continuationToken={continuationToken}"
+
+        for _ in range(10):
+            response = requests.get(url=url, headers=self.auth.get_headers())
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code not in (200, 429):
+                raise Exception(f"Error listing external data shares: {response.status_code}, {response.text}")
+            break
+
+        response = json.loads(response.text)
+        list_data_shares = response["value"]
+
+        if "continuationToken" in response and response["continuationToken"] is not None:
+            list_data_shares_next = self.list_external_data_shares(continuationToken=response["continuationToken"])
+            list_data_shares.extend(list_data_shares_next)
+        return list_data_shares
+    
+    def revoke_external_data_share(self, external_data_share_id, item_id, workspace_id):
+        # POST https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/externalDataShares/{externalDataShareId}/revoke
+        """Revoke an external data share"""
+        url = f"https://api.fabric.microsoft.com/v1/admin/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke"
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers())
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code not in (200, 429):
+                raise Exception(f"Error revoking external data share: {response.status_code}, {response.text}")
+            break
+
+        return response.status_code
+

{msfabricpysdkcore-0.0.11 → msfabricpysdkcore-0.0.13}/msfabricpysdkcore/coreapi.py

@@ -81,10 +81,10 @@ class FabricClientCore(FabricClient):
             return self.get_workspace_by_name(name)
         raise ValueError("Either id or name must be provided")
         
-    def get_workspace_role_assignments(self, workspace_id):
+    def list_workspace_role_assignments(self, workspace_id):
         """Get role assignments for a workspace"""
         ws = self.get_workspace_by_id(workspace_id)
-        return ws.get_role_assignments()
+        return ws.list_role_assignments()
     
     def create_workspace(self, display_name, capacity_id = None, description = None, exists_ok = True):
         """Create a workspace"""
@@ -129,20 +129,25 @@ class FabricClientCore(FabricClient):
         ws = self.get_workspace_by_id(workspace_id)
         return ws.add_role_assignment(role, principal)
     
-    def delete_workspace_role_assignment(self, workspace_id, principal_id):
+    def delete_workspace_role_assignment(self, workspace_id, workspace_role_assignment_id):
         """Delete a role assignment from a workspace"""
         ws = self.get_workspace_by_id(workspace_id)
-        return ws.delete_role_assignment(principal_id)
+        return ws.delete_role_assignment(workspace_role_assignment_id)
     
     def update_workspace(self, workspace_id, display_name = None, description = None):
         """Update a workspace"""
         ws = self.get_workspace_by_id(workspace_id)
         return ws.update(display_name, description)
+
+    def get_workspace_role_assignment(self, workspace_id, workspace_role_assignment_id):
+        """Get a role assignment for a workspace"""
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.get_role_assignment(workspace_role_assignment_id)
     
-    def update_workspace_role_assignment(self, workspace_id, role, principal_id):
+    def update_workspace_role_assignment(self, workspace_id, role, workspace_role_assignment_id):
         """Update a role assignment for a workspace"""
         ws = self.get_workspace_by_id(workspace_id)
-        return ws.update_role_assignment(role, principal_id)
+        return ws.update_role_assignment(role, workspace_role_assignment_id)
 
     def assign_to_capacity(self, workspace_id, capacity_id):
         """Assign a workspace to a capacity"""
@@ -153,6 +158,16 @@ class FabricClientCore(FabricClient):
         """Unassign a workspace from a capacity"""
         ws = self.get_workspace_by_id(workspace_id)
         return ws.unassign_from_capacity()
+    
+    def provision_identity(self, workspace_id):
+        """Provision an identity for a workspace"""
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.provision_identity()
+    
+    def deprovision_identity(self, workspace_id):
+        """Deprovision an identity for a workspace"""
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.deprovision_identity()
  
     def list_capacities(self, continuationToken = None):
         """List all capacities in the tenant"""
@@ -809,6 +824,11 @@ class FabricClientCore(FabricClient):
         ws = self.get_workspace_by_id(workspace_id)
         return ws.update_spark_job_definition_definition(spark_job_definition_id, definition)
     
+    def run_on_demand_spark_job_definition(self, workspace_id, spark_job_definition_id, job_type = "sparkjob"):
+        """Run an on demand spark job definition"""
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.run_on_demand_spark_job_definition(spark_job_definition_id, job_type)
+    
     # warehouses
 
     def list_warehouses(self, workspace_id, with_properties = False):
@@ -991,4 +1011,49 @@ class FabricClientCore(FabricClient):
         return ws.update_spark_settings(automatic_log=automatic_log, 
                                         environment=environment, 
                                         high_concurrency=high_concurrency, 
-                                        pool=pool)
+                                        pool=pool)
+    
+
+    # External Data Shares
+
+    # create
+
+    def create_external_data_share(self, workspace_id, item_id, paths, recipient):
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.create_external_data_share(item_id=item_id, paths = paths, recipient = recipient)
+
+    # get
+
+    def get_external_data_share(self, workspace_id, item_id, external_data_share_id):
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.get_external_data_share(item_id=item_id, external_data_share_id=external_data_share_id)
+
+    # list
+
+    def list_external_data_shares_in_item(self, workspace_id, item_id):
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.list_external_data_shares_in_item(item_id=item_id)
+
+    # revoke
+
+    def revoke_external_data_share(self, workspace_id, item_id, external_data_share_id):
+        ws = self.get_workspace_by_id(workspace_id)
+        return ws.revoke_external_data_share(item_id=item_id, external_data_share_id=external_data_share_id)
+    
+
+    # One Lake Data Access Security
+
+    # create and update
+
+    def create_or_update_data_access_roles(self, workspace_id, item_id, data_access_roles, dryrun = False, etag_match = None):
+        ws = self.get_workspace_by_id(workspace_id)
+        item =  ws.get_item(item_id=item_id).create_or_update_data_access_roles(data_access_roles = data_access_roles,
+                                                                                  dryrun = dryrun, etag_match = etag_match)
+        return item
+    
+    # list 
+
+    def list_data_access_roles(self, workspace_id, item_id):
+        ws = self.get_workspace_by_id(workspace_id)
+        item = ws.get_item(item_id=item_id)
+        return item.list_data_access_roles()

{msfabricpysdkcore-0.0.11 → msfabricpysdkcore-0.0.13}/msfabricpysdkcore/environment.py

@@ -135,16 +135,17 @@ class Environment(Item):
         # POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries
         raise NotImplementedError("Not implemented yet")
         # url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.workspace_id}/environments/{self.id}/staging/libraries"
-
-        # for _ in range(10):
-        #     response = requests.post(url=url, files={'file': file_path}, headers=self.auth.get_headers())
-        #     if response.status_code == 429:
-        #         print("Too many requests, waiting 10 seconds")
-        #         sleep(10)
-        #         continue
-        #     if response.status_code not in (200, 429):
-        #         raise Exception(f"Error uploading staging libraries: {response.status_code}, {response.text}")
-        #     break
+        # with open(file_path, 'rb') as f:
+        #     files = {"upload_file.whl": f}
+        #     for _ in range(10):
+        #         response = requests.post(url=url, files=files, headers=self.auth.get_headers())
+        #         if response.status_code == 429:
+        #             print("Too many requests, waiting 10 seconds")
+        #             sleep(10)
+        #             continue
+        #         if response.status_code not in (200, 429):
+        #             raise Exception(f"Error uploading staging libraries: {response.status_code}, {response.text}")
+        #         break
 
         # return json.loads(response.text)