msfabricpysdkcore 0.0.8__tar.gz → 0.0.10__tar.gz

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.8
+Version: 0.0.10
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core
@@ -24,7 +24,7 @@ They are designed to automate your Fabric processes.
 
 This SDK helps to interact with the Fabric APIs in a more Pythonic way.
 Additionally it brings some extra features like:
-- Authentication is handled for you (currently Azure CLI Authentication  and Service Principal Authentication are supported)
+- Authentication is handled for you (currently Azure CLI Authentication and Service Principal Authentication are supported, as well as Synapse Spark Authentication in Fabric Notebooks)
 - Waiting for completion of long running operations
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
@@ -37,22 +37,24 @@ See the latest release notes [here](releasenotes/release_notes.md).
 Currently it supports all Core APIs, Admin APIs, Lakehouse APIs and all other item specific CRUD APIs, i.e.:
 - Core APIs
   - [Capacities](#working-with-capacities)
+  - [Deployment Pipelines](#deployment-pipelines)
   - [Git](#working-with-git)
   - [Items](#working-with-items)
   - [Job Scheduler](#working-with-job-scheduler)
-  - Long Running Operations
+  - [Long Running Operations](#long-running-operations)
   - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
   - [Workspaces](#working-with-workspaces)
-- Lakehouse APIs
-  - [Tables](#tables)
 - Admin APIs
   - [Domains](#admin-api-for-domains)
   - [Items](#admin-api-for-items)
+  - [Labels](#admin-api-for-labels)
   - [Tenants](#admin-api-for-tenants)
   - [Users](#admin-api-for-users)
   - [Workspaces](#admin-api-for-workspaces)
-- [Item Specific CRUD APIs](item_specific_apis.md), e.g.
+- [Item Specific APIs](item_specific_apis.md), e.g.
   - List, create, update, delete warehouses, notebooks, semantic models, kql databases,.....
+  - Lakehouse operations (Load table, list tables, run table maintenance)
+  - Spark Pool operations
 
 It is planned to support also new APIs which are not released yet.
 Also we have plans to support APIs to interact with Fabric capacities on the Azure Side.
@@ -194,6 +196,45 @@ ws.unassign_from_capacity()
 fc.list_capacities()
 ```
 
+### Deployment Pipelines
+
+```python
+
+
+# List deployment pipelines 
+
+depl_pipes = fc.list_deployment_pipelines()
+
+pipe = [pipe for pipe in depl_pipes if pipe.display_name == 'sdkpipe'][0]
+pipe_id = pipe.id
+
+# Get a deployment pipeline
+pipe = fc.get_deployment_pipeline(pipe_id)
+
+
+# Get deployment pipeline stages
+stages = fc.get_deployment_pipeline_stages(pipe_id)
+
+names = [stage.display_name for stage in stages]
+
+dev_stage = [stage for stage in stages if stage.display_name == "Development"][0]
+prod_stage = [stage for stage in stages if stage.display_name == "Production"][0]
+
+# Get deployment pipeline stages items
+items = fc.get_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
+
+
+items = [item for item in dev_stage.get_items() if item["itemDisplayName"] == 'cicdlakehouse']
+item = items[0]
+item = {"sourceItemId": item["itemId"],
+        "itemType": item["itemType"]}
+items = [item]
+
+# Deploy stage content
+response = pipe.deploy(source_stage_id=dev_stage.id,target_stage_id=prod_stage.id, items=items)
+
+```
+
 ### Working with items
 
 ```python
@@ -380,37 +421,24 @@ item.cancel_item_job_instance(job_instance_id="job_instance_id")
 
 ```
 
-### Tables
-
 
+### Long Running Operations
 
 ```python
-# List tables in a Lakehouse
 
-from msfabricpysdkcore import FabricClientCore
+# Get the state of an operation
 
-fc = FabricClientCore()
-ws = fc.get_workspace_by_name("testworkspace")
-lakehouse = ws.get_item_by_name(item_name="lakehouse1", item_type="Lakehouse")
-table_list = lakehouse.list_tables()
-# or
-table_list = ws.list_tables(item_id = "someitemid")
-# or
-table_list = fc.list_tables(workspace_id = "someworkspaceid", item_id = "someitemid")
+operation_id = "801783df0123gsdgsq80"
 
+state = fc.get_operation_state(operation_id)
 
-# Load a file (like a csv) into a Lakehouse table
+# Get the results of an operation
 
-lakehouse.load_table(table_name="testtable", path_type= "File", relative_path="Files/folder1/titanic.csv")
-# or
-ws.load_table(item_id = "someitemid", table_name="testtable",
-              path_type= "File", relative_path="Files/folder1/titanic.csv")
-# or
-fc.load_table(workspace_id = "someworkspaceid", item_id = "someitemid", table_name="testtable",
-              path_type= "File", relative_path="Files/folder1/titanic.csv")
+results = fc.get_operation_results(operation_id)
 
 ```
 
+
 ### Admin API for Workspaces
 
 ```python
@@ -427,9 +455,9 @@ ws = fca.get_workspace(workspace_id="workspace_id")
 
 # Get workspace access details
 
-ws_access = fca.get_workspace_access_details("workspace_id")
+ws_access = fca.list_workspace_access_details("workspace_id")
 # or
-ws_access = ws.get_access_details()
+ws_access = ws.list_access_details()
 ```
 
 ### Admin API for Users
@@ -442,7 +470,7 @@ fca = FabricClientAdmin()
 # Get access entities
 
 user_id = 'b4fuhaidc2'
-access_entities = fca.get_access_entities(user_id, type="Notebook")
+access_entities = fca.list_access_entities(user_id, type="Notebook")
 
 ```
 
@@ -455,11 +483,11 @@ fca = FabricClientAdmin()
 
 # Get tenant settings
 
-tenant_settings = fca.get_tenant_settings()
+tenant_settings = fca.list_tenant_settings()
 
 # Get capacity tenant settings overrides
 
-overrides = fca.get_capacities_tenant_settings_overrides()
+overrides = fca.list_capacities_tenant_settings_overrides()
 
 ```
 
@@ -482,14 +510,36 @@ item = ws.get_item(item_id=item_list[0].id)
 
 # Get item access details
 
-item_access = fca.get_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
+item_access = fca.list_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
 #or
-item_access = ws.get_item_access_details(item_id=item_list[0].id)
+item_access = ws.list_item_access_details(item_id=item_list[0].id)
 # or
 item_access = item.get_access_details()
 
 ```
 
+### Admin API for Labels
+
+```python
+
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+items = [{"id": "d417b843534cf0-23423523", "type": "Lakehouse"}]
+label_id = "de8912714345d2" # to be found in Microsoft Purview Compliance Center
+
+# Bulk set labels 
+
+resp = fca.bulk_set_labels(items=items, label_id=label_id)
+
+# Bulk remove labels
+
+resp = fca.bulk_remove_labels(items=items)
+
+```
+
+
 ### Admin API for Domains
 
 ```python

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/README.md

@@ -9,7 +9,7 @@ They are designed to automate your Fabric processes.
 
 This SDK helps to interact with the Fabric APIs in a more Pythonic way.
 Additionally it brings some extra features like:
-- Authentication is handled for you (currently Azure CLI Authentication  and Service Principal Authentication are supported)
+- Authentication is handled for you (currently Azure CLI Authentication and Service Principal Authentication are supported, as well as Synapse Spark Authentication in Fabric Notebooks)
 - Waiting for completion of long running operations
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
@@ -22,22 +22,24 @@ See the latest release notes [here](releasenotes/release_notes.md).
 Currently it supports all Core APIs, Admin APIs, Lakehouse APIs and all other item specific CRUD APIs, i.e.:
 - Core APIs
   - [Capacities](#working-with-capacities)
+  - [Deployment Pipelines](#deployment-pipelines)
   - [Git](#working-with-git)
   - [Items](#working-with-items)
   - [Job Scheduler](#working-with-job-scheduler)
-  - Long Running Operations
+  - [Long Running Operations](#long-running-operations)
   - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
   - [Workspaces](#working-with-workspaces)
-- Lakehouse APIs
-  - [Tables](#tables)
 - Admin APIs
   - [Domains](#admin-api-for-domains)
   - [Items](#admin-api-for-items)
+  - [Labels](#admin-api-for-labels)
   - [Tenants](#admin-api-for-tenants)
   - [Users](#admin-api-for-users)
   - [Workspaces](#admin-api-for-workspaces)
-- [Item Specific CRUD APIs](item_specific_apis.md), e.g.
+- [Item Specific APIs](item_specific_apis.md), e.g.
   - List, create, update, delete warehouses, notebooks, semantic models, kql databases,.....
+  - Lakehouse operations (Load table, list tables, run table maintenance)
+  - Spark Pool operations
 
 It is planned to support also new APIs which are not released yet.
 Also we have plans to support APIs to interact with Fabric capacities on the Azure Side.
@@ -179,6 +181,45 @@ ws.unassign_from_capacity()
 fc.list_capacities()
 ```
 
+### Deployment Pipelines
+
+```python
+
+
+# List deployment pipelines 
+
+depl_pipes = fc.list_deployment_pipelines()
+
+pipe = [pipe for pipe in depl_pipes if pipe.display_name == 'sdkpipe'][0]
+pipe_id = pipe.id
+
+# Get a deployment pipeline
+pipe = fc.get_deployment_pipeline(pipe_id)
+
+
+# Get deployment pipeline stages
+stages = fc.get_deployment_pipeline_stages(pipe_id)
+
+names = [stage.display_name for stage in stages]
+
+dev_stage = [stage for stage in stages if stage.display_name == "Development"][0]
+prod_stage = [stage for stage in stages if stage.display_name == "Production"][0]
+
+# Get deployment pipeline stages items
+items = fc.get_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
+
+
+items = [item for item in dev_stage.get_items() if item["itemDisplayName"] == 'cicdlakehouse']
+item = items[0]
+item = {"sourceItemId": item["itemId"],
+        "itemType": item["itemType"]}
+items = [item]
+
+# Deploy stage content
+response = pipe.deploy(source_stage_id=dev_stage.id,target_stage_id=prod_stage.id, items=items)
+
+```
+
 ### Working with items
 
 ```python
@@ -365,37 +406,24 @@ item.cancel_item_job_instance(job_instance_id="job_instance_id")
 
 ```
 
-### Tables
-
 
+### Long Running Operations
 
 ```python
-# List tables in a Lakehouse
 
-from msfabricpysdkcore import FabricClientCore
+# Get the state of an operation
 
-fc = FabricClientCore()
-ws = fc.get_workspace_by_name("testworkspace")
-lakehouse = ws.get_item_by_name(item_name="lakehouse1", item_type="Lakehouse")
-table_list = lakehouse.list_tables()
-# or
-table_list = ws.list_tables(item_id = "someitemid")
-# or
-table_list = fc.list_tables(workspace_id = "someworkspaceid", item_id = "someitemid")
+operation_id = "801783df0123gsdgsq80"
 
+state = fc.get_operation_state(operation_id)
 
-# Load a file (like a csv) into a Lakehouse table
+# Get the results of an operation
 
-lakehouse.load_table(table_name="testtable", path_type= "File", relative_path="Files/folder1/titanic.csv")
-# or
-ws.load_table(item_id = "someitemid", table_name="testtable",
-              path_type= "File", relative_path="Files/folder1/titanic.csv")
-# or
-fc.load_table(workspace_id = "someworkspaceid", item_id = "someitemid", table_name="testtable",
-              path_type= "File", relative_path="Files/folder1/titanic.csv")
+results = fc.get_operation_results(operation_id)
 
 ```
 
+
 ### Admin API for Workspaces
 
 ```python
@@ -412,9 +440,9 @@ ws = fca.get_workspace(workspace_id="workspace_id")
 
 # Get workspace access details
 
-ws_access = fca.get_workspace_access_details("workspace_id")
+ws_access = fca.list_workspace_access_details("workspace_id")
 # or
-ws_access = ws.get_access_details()
+ws_access = ws.list_access_details()
 ```
 
 ### Admin API for Users
@@ -427,7 +455,7 @@ fca = FabricClientAdmin()
 # Get access entities
 
 user_id = 'b4fuhaidc2'
-access_entities = fca.get_access_entities(user_id, type="Notebook")
+access_entities = fca.list_access_entities(user_id, type="Notebook")
 
 ```
 
@@ -440,11 +468,11 @@ fca = FabricClientAdmin()
 
 # Get tenant settings
 
-tenant_settings = fca.get_tenant_settings()
+tenant_settings = fca.list_tenant_settings()
 
 # Get capacity tenant settings overrides
 
-overrides = fca.get_capacities_tenant_settings_overrides()
+overrides = fca.list_capacities_tenant_settings_overrides()
 
 ```
 
@@ -467,14 +495,36 @@ item = ws.get_item(item_id=item_list[0].id)
 
 # Get item access details
 
-item_access = fca.get_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
+item_access = fca.list_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
 #or
-item_access = ws.get_item_access_details(item_id=item_list[0].id)
+item_access = ws.list_item_access_details(item_id=item_list[0].id)
 # or
 item_access = item.get_access_details()
 
 ```
 
+### Admin API for Labels
+
+```python
+
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+items = [{"id": "d417b843534cf0-23423523", "type": "Lakehouse"}]
+label_id = "de8912714345d2" # to be found in Microsoft Purview Compliance Center
+
+# Bulk set labels 
+
+resp = fca.bulk_set_labels(items=items, label_id=label_id)
+
+# Bulk remove labels
+
+resp = fca.bulk_remove_labels(items=items)
+
+```
+
+
 ### Admin API for Domains
 
 ```python

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/msfabricpysdkcore/admin_item.py

@@ -83,6 +83,13 @@ class AdminItem:
     def get_item_access_details(self, type=None):
         """Get the access details of the item
         
+        Returns:
+            dict: The access details of the item"""
+        return self.list_item_access_details(type)
+        
+    def list_item_access_details(self, type=None):
+        """Get the access details of the item
+        
         Returns:
             dict: The access details of the item"""
         

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/msfabricpysdkcore/admin_workspace.py

@@ -70,6 +70,14 @@ class AdminWorkspace:
     def get_workspace_access_details(self):
         """Get the access details of the workspace
 
+        Returns:
+            dict: The access details of the workspace
+        """
+        return self.list_workspace_access_details()
+    
+    def list_workspace_access_details(self):
+        """Get the access details of the workspace
+
         Returns:
             dict: The access details of the workspace
         """
@@ -115,6 +123,17 @@ class AdminWorkspace:
         item_dict = json.loads(response.text) 
         return AdminItem.from_dict(item_dict, self.auth)
     
+    def list_item_access_details(self, item_id, type=None):
+        """Get the access details of the item
+        
+        Args:
+            item_id (str): The ID of the item
+            type (str): The type of the item
+        Returns:
+            dict: The access details of the item
+        """
+        return self.get_item(item_id, type).list_item_access_details()
+
     def get_item_access_details(self, item_id, type=None):
         """Get the access details of the item
         
@@ -124,4 +143,4 @@ class AdminWorkspace:
         Returns:
             dict: The access details of the item
         """
-        return self.get_item(item_id, type).get_item_access_details()
+        return self.list_item_access_details(item_id, type)

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/msfabricpysdkcore/adminapi.py

@@ -284,13 +284,24 @@ class FabricClientAdmin(FabricClient):
     def get_workspace_access_details(self, workspace_id):
         """Get the access details of the workspace
         
+        Args:
+            workspace_id (str): The ID of the workspace
+        Returns:
+            dict: The access details of the workspace
+        """
+        print("DEPRECATED: Use list_workspace_access_details instead")
+        return self.list_workspace_access_details(workspace_id)
+
+    def list_workspace_access_details(self, workspace_id):
+        """Get the access details of the workspace
+        
         Args:
             workspace_id (str): The ID of the workspace
         Returns:
             dict: The access details of the workspace
         """
         ws = self.get_workspace(workspace_id)
-        return ws.get_workspace_access_details()
+        return ws.list_workspace_access_details()
     
     def list_workspaces(self, capacity_id = None, name=None, state=None, type=None, continuationToken = None):
         """List all workspaces
@@ -426,6 +437,15 @@ class FabricClientAdmin(FabricClient):
     def get_tenant_settings(self):
         """Get the tenant settings
         
+        Returns:
+            dict: The tenant settings
+        """
+        print("DEPRECATED: Use list_tenant_settings instead")
+        return self.list_tenant_settings()
+    
+    def list_tenant_settings(self):
+        """Get the tenant settings
+        
         Returns:
             dict: The tenant settings
         """
@@ -445,7 +465,7 @@ class FabricClientAdmin(FabricClient):
         return json.loads(response.text)
     
 
-    def get_capacities_tenant_settings_overrides(self, continuationToken = None):
+    def list_capacities_tenant_settings_overrides(self, continuationToken = None):
         """Returns list of tenant setting overrides that override at the capacities
         
         Returns:
@@ -471,12 +491,35 @@ class FabricClientAdmin(FabricClient):
         overrides = resp_dict["Overrides"]
 
         if "continuationToken" in resp_dict and resp_dict["continuationToken"] is not None:
-            overrides_next = self.get_capacities_tenant_settings_overrides(continuationToken=resp_dict["continuationToken"])
+            overrides_next = self.list_capacities_tenant_settings_overrides(continuationToken=resp_dict["continuationToken"])
             overrides.extend(overrides_next)
 
         return overrides
+
+    def get_capacities_tenant_settings_overrides(self):
+        """Returns list of tenant setting overrides that override at the capacities
+        
+        Returns:
+            list: The capacities tenant settings overrides
+        """
+        print("DEPRECATED: Use list_capacities_tenant_settings_overrides instead")
+        return self.list_capacities_tenant_settings_overrides()
     
-    def get_access_entities(self, user_id, type = None, continuationToken = None):
+
+    def get_access_entities(self, user_id, type = None):
+        """Get the access entities for a user
+        
+        Args:
+            user_id (str): The ID of the user
+            type (str): The type of the access entity
+            continuationToken (str): The continuation token
+        Returns:
+            list: The list of access entities
+        """
+        print("DEPRECATED: Use list_access_entities instead")
+        return self.list_access_entities(user_id, type)
+
+    def list_access_entities(self, user_id, type = None, continuationToken = None):
         """Get the access entities for a user
         
         Args:
@@ -515,12 +558,12 @@ class FabricClientAdmin(FabricClient):
         access_entities = resp_dict["accessEntities"]
 
         if "continuationToken" in resp_dict and resp_dict["continuationToken"] is not None:
-            access_entities_next = self.get_access_entities(user_id, type, continuationToken=resp_dict["continuationToken"])
+            access_entities_next = self.list_access_entities(user_id, type, continuationToken=resp_dict["continuationToken"])
             resp_dict["accessEntities"].extend(access_entities_next)
         
         return access_entities
     
-    def get_item_access_details(self, workspace_id, item_id, type=None):
+    def list_item_access_details(self, workspace_id, item_id, type=None):
         """Get the access details of the item
         
         Args:
@@ -532,4 +575,87 @@ class FabricClientAdmin(FabricClient):
         """
         ws = self.get_workspace(workspace_id)
         item = ws.get_item(item_id, type)
-        return item.get_item_access_details(type)
+        return item.list_item_access_details(type)
+    
+    def get_item_access_details(self, workspace_id, item_id, type=None):
+        """Get the access details of the item
+        
+        Args:
+            workspace_id (str): The ID of the workspace
+            item_id (str): The ID of the item
+            type (str): The type of the item
+        Returns:
+            dict: The access details of the item
+        """
+        print("DEPRECATED: Use list_item_access_details instead")
+        return self.list_item_access_details(workspace_id, item_id, type)
+    
+    def bulk_set_labels(self, items, label_id, assignment_method = None, delegated_principal = None):
+        """Set labels in bulk"""
+        # POST https://api.fabric.microsoft.com/v1/admin/items/bulkSetLabels
+
+        url = "https://api.fabric.microsoft.com/v1/admin/items/bulkSetLabels"
+
+        if len(items) > 2000:
+            self.bulk_set_labels(items[2000:], label_id, assignment_method, delegated_principal)
+            items = items[:2000]
+
+        body = {
+            "items": items,
+            "labelId": label_id
+        }
+        if assignment_method:
+            body["assignmentMethod"] = assignment_method
+
+        if delegated_principal:
+            body["delegatedPrincipal"] = delegated_principal
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code not in (200, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error setting labels: {response.text}")
+            break
+
+        response = json.loads(response.text)
+        return response
+    
+
+    def bulk_remove_labels(self, items):
+        """Remove labels in bulk
+        Args:
+            items (list): The list of item IDs
+            
+        Returns:
+            dict: The response from the API"""
+        # POST https://api.fabric.microsoft.com/v1/admin/items/bulkRemoveLabels
+
+        url = "https://api.fabric.microsoft.com/v1/admin/items/bulkRemoveLabels"
+
+        if len(items) > 2000:
+            self.bulk_remove_labels(items[2000:])
+            items = items[:2000]
+        
+        body = {
+            "items": items
+        }
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code not in (200, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error removing labels: {response.text}")
+            break
+
+        response = json.loads(response.text)
+        return response

{msfabricpysdkcore-0.0.8 → msfabricpysdkcore-0.0.10}/msfabricpysdkcore/auth.py

@@ -72,6 +72,6 @@ class FabricSparkUtilsAuthentication(FabricAuth):
     def get_token(self):
         """Get token from Azure AD"""
         token = mssparkutils.credentials.getToken("pbi")
-        return token.token
+        return token