msfabricpysdkcore 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

{msfabricpysdkcore-0.0.2.dist-info → msfabricpysdkcore-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.2
+Version: 0.0.4
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core
@@ -13,9 +13,9 @@ License-File: LICENSE
 Requires-Dist: requests >=2.30.0
 Requires-Dist: azure-identity >=1.15.0
 
-# A Python SDK for Microsoft Fabric
+# Python SDK for Microsoft Fabric
 
-This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs of Fabric*.
+This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs (v1) of Fabric*.
 
 ![Python hugging a F](assets/fabricpythontransparent.png)
 
@@ -29,24 +29,35 @@ Additionally it brings some extra features like:
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
 - More granular objects, e.g. a Workspace and Item object instead of referencing IDs all the time
-- Do bulk operations**
-- Pagination support**
-
-Currently it supports all Core APIs, i.e.:
-- [Capacities](#working-with-capacities)
-- [Git](#working-with-git)
-- [Items](#working-with-items)
-- [Job Scheduler](#working-with-job-scheduler)
-- Long Running Operations
-- [OneLakeShortcuts](#working-with-one-lake-shortcuts)
-- [Workspaces](#working-with-workspaces)
-
-It is planned to support also the Admin and Lakehouse APIs and new APIs which are not released yet.
+- Do bulk operations (see [Usage Patterns](usage_patterns.md))
+- Pagination support
+
+See the latest release notes [here](releasenotes/release_notes.md).
+
+Currently it supports all Core APIs, Admin APIs and Lakehouse APIs, i.e.:
+- Core APIs
+  - [Capacities](#working-with-capacities)
+  - [Git](#working-with-git)
+  - [Items](#working-with-items)
+  - [Job Scheduler](#working-with-job-scheduler)
+  - 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)
+  - [Tenants](#admin-api-for-tenants)
+  - [Users](#admin-api-for-users)
+  - [Workspaces](#admin-api-for-workspaces)
+
+It is planned to support also the APIs of the user experiences and new APIs which are not released yet.
+Also we have plans to support APIs to interact with Fabric capacities on the Azure Side.
 Eventually Power BI APIs like the Scanner API will be covered as well.
 
 *Because this SDK uses the API in the background, all limitations and restrictions of the API apply to this SDK as well. This includes rate limits, permissions, etc.
 
-**These features are not yet implemented but are planned for the near future.
 
 
 
@@ -160,11 +171,16 @@ ws.delete_role_assignment(principal_id = "abadfbafb")
 
 ```python
 
+
+capacity_object = fc.get_capacity(capacity_id = "0129389012u8938491") 
+#or 
+capacity_object = fc.get_capacity(capacity_name = "sandboxcapacitygermanywc") 
+
 # Assign a capaycity to a workspace
 fc.assign_to_capacity(workspace_id=workspace_id,
-                      capacity_id="capacityid123123")
+                      capacity_id=capacity_object.id)
 # or
-ws.assign_to_capacity(capacity_id="capacityid123123")      
+ws.assign_to_capacity(capacity_id=capacity_object.id)      
 
 # Unassign from capacity
 fc.unassign_from_capacity(workspace_id=ws.id)
@@ -359,6 +375,172 @@ item.cancel_item_job_instance(job_instance_id="job_instance_id")
 
 ```
 
+### Tables
+
+
+
+```python
+# List tables in a Lakehouse
+
+from msfabricpysdkcore import FabricClientCore
+
+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")
+
+
+# Load a file (like a csv) into a Lakehouse table
+
+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")
+
+```
+
+### Admin API for Workspaces
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+
+# List workspaces
+ws = fca.list_workspaces(name="testworkspace")[0]
+
+# Get workspace
+ws = fca.get_workspace(workspace_id="workspace_id")
+
+# Get workspace access details
+
+ws_access = fca.get_workspace_access_details("workspace_id")
+# or
+ws_access = ws.get_access_details()
+```
+
+### Admin API for Users
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get access entities
+
+user_id = 'b4fuhaidc2'
+access_entities = fca.get_access_entities(user_id, type="Notebook")
+
+```
+
+### Admin API for Tenants
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get tenant settings
+
+tenant_settings = fca.get_tenant_settings()
+
+# Get capacity tenant settings overrides
+
+overrides = fca.get_capacities_tenant_settings_overrides()
+
+```
+
+### Admin API for Items
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# List items
+
+item_list = fca.list_items(workspace_id="wsid")
+
+# Get item
+
+item = fca.get_item(workspace_id="wsid", item_id=item_list[0].id)
+# or
+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)
+#or
+item_access = ws.get_item_access_details(item_id=item_list[0].id)
+# or
+item_access = item.get_access_details()
+
+```
+
+### Admin API for Domains
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Create domain
+domain_name = "sdktestdomains"
+domain = fca.create_domain(display_name=domain_name)
+
+# Get domain by name
+domain_clone = fca.get_domain_by_name(domain_name)
+
+# Get domain by id
+domain_clone = fca.get_domain_by_id(domain.id)
+
+# List domains
+domains = fca.list_domains()
+
+# Update domain
+domain_new_name = "sdktestdomains2"
+domain_clone = fca.update_domain(domain.id, display_name=domain_new_name)
+
+# Assign domain workspaces by Ids
+fca.assign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# List domain workspaces
+workspaces = fca.list_domain_workspaces(domain.id, workspace_objects=True)
+
+# Unassign domain workspaces by ids
+status_code = fca.unassign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# Assign domain workspaces by capacities
+status_code = fca.assign_domain_workspaces_by_capacities(domain.id, ["cap_id1", "cap_id2"])
+
+# Unassign all domain workspaces
+status_code = fca.unassign_all_domain_workspaces(domain.id)
+
+# Assign domain workspaces by principals
+principal1 = {'id': '6edbsdfbfdgdf656', 'type': 'User'}
+principal2 = {'id': '6eyxcbyyxc57', 'type': 'User'}
+
+status_code = fca.assign_domains_workspaces_by_principals(domain.id, [principal1, principal2], wait_for_completion=True)
+
+# Role assignments bulk assign
+
+principals = [principal, principal_2]
+status_code = fca.role_assignments_bulk_assign(domain.id, "Contributors", principals)
+
+# Role assignments bulk unassign
+status_code = fca.role_assignments_bulk_unassign(domain.id, "Contributors", [principal_2])
+
+# Delete domain
+status_code = fca.delete_domain(domain.id)
+```
 
 
 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.

msfabricpysdkcore-0.0.4.dist-info/RECORD

@@ -0,0 +1,28 @@
+msfabricpysdkcore/__init__.py,sha256=nh8-lxdMBWYSbQpbRxWkn3ZRpGipmQplTudjskN2l88,78
+msfabricpysdkcore/admin_item.py,sha256=YfZiNAwqojwxSLsHXmYG_uO6_ILIQqLsOVh79HeWsuw,3778
+msfabricpysdkcore/admin_workspace.py,sha256=OtBI7EWOa44rgIdIDG9dU2l-nMRYpOeIaoP5BPHKUPA,4248
+msfabricpysdkcore/adminapi.py,sha256=YzK3s-CoFkzwOXrWPxoUeXFpv16ZwNujieaZI63bhqI,21039
+msfabricpysdkcore/auth.py,sha256=1t5prgSg2hK7vMutif2lxHOQk_qTo3152h3FMof3y_4,1929
+msfabricpysdkcore/capacity.py,sha256=Q_2-XrZtdf9F67fY0qU3D0ocEOGQq4KtIXAv9dXjQhI,1761
+msfabricpysdkcore/client.py,sha256=XVa9xndx-b2f7rA8zR-9fXyon1Ig1MmSwIMNXDfUdhw,1060
+msfabricpysdkcore/coreapi.py,sha256=uQLBgght07CcRZbliUORq-EN1SJYtLOSYWjX8jAo4wA,14367
+msfabricpysdkcore/domain.py,sha256=i8jMJEutDRL5XuQ69woCVQEzLS_lm9uUxl4Kp3xtxHc,14722
+msfabricpysdkcore/item.py,sha256=S_E6WzcY_zIAAmtsLh5n_r6ziOqn4916cZtk49tGceA,11155
+msfabricpysdkcore/job_instance.py,sha256=EYruSPpBUP3NXz7oVecyrDwwD7g2u25i9UhteC6HFyU,2828
+msfabricpysdkcore/lakehouse.py,sha256=phXIuKdW0khJMJx_BK2X3TJRPXSJ_9B1QKFnt2k7WH4,4011
+msfabricpysdkcore/long_running_operation.py,sha256=PvrVEuasD9lwdJZ6ElsNwBE1G8xW5uDQ8zXcKqpOpXc,3021
+msfabricpysdkcore/onelakeshortcut.py,sha256=EYZfP-rl60HdCqJD1O1NXrQTgrYTIw-EWisF4hs4bTU,2102
+msfabricpysdkcore/workspace.py,sha256=_kgBmxPrqHxYN8U0OyzzmLcW-ecgFitOkyD0xhzjGcI,21544
+msfabricpysdkcore/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+msfabricpysdkcore/tests/test_admin_apis.py,sha256=M-WWQBgOG03hobCEH3dTu9VkJzyFLLN-yE9A9sdsi_8,2062
+msfabricpysdkcore/tests/test_domains.py,sha256=GJX5WA_pEMYzeOGB-GAml0vnnj5AZqa7akSZB-yeBeA,4649
+msfabricpysdkcore/tests/test_git.py,sha256=6OERflBSYfJbdPYuHeTEtUl2ZVqiJERVY0Z1APt94_g,2398
+msfabricpysdkcore/tests/test_items_incl_lakehouse.py,sha256=Hf_E2SRwwxT0MOO_T1YbRs8j-NJ_CxKbGktJgIHuz-U,2941
+msfabricpysdkcore/tests/test_jobs.py,sha256=G3edmNO9FpRgaVnG3RR_MTtxfSTLhp05-HBKWsRNJF8,1581
+msfabricpysdkcore/tests/test_shortcuts.py,sha256=2Y4R-PfzpqaD3fEsZ7gMYGCnMPZSlgsw7V4jxZHewdU,2390
+msfabricpysdkcore/tests/test_workspaces_capacities.py,sha256=2VHPvZ8GnpFStgUoZ-Al3kVVVimjkAs9YG47NsFl-zo,6563
+msfabricpysdkcore-0.0.4.dist-info/LICENSE,sha256=1NrGuF-zOmzbwzk3iI6lsP9koyDeKO1B0-8OD_tTvOQ,1156
+msfabricpysdkcore-0.0.4.dist-info/METADATA,sha256=BAoWOWMQxH9w71RiJ0PHTDFG11TaePLnkZbmJTHt_h0,16186
+msfabricpysdkcore-0.0.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+msfabricpysdkcore-0.0.4.dist-info/top_level.txt,sha256=3iRonu6ptDGQN4Yl6G76XGM7xbFNsskiEHW-P2gMQGY,18
+msfabricpysdkcore-0.0.4.dist-info/RECORD,,

msfabricpysdkcore-0.0.2.dist-info/RECORD

@@ -1,13 +0,0 @@
-msfabricpysdkcore/__init__.py,sha256=HJeyM1aLgf9AvUGkU4Olky90YyySletA281VbSa0Q2c,36
-msfabricpysdkcore/auth.py,sha256=1t5prgSg2hK7vMutif2lxHOQk_qTo3152h3FMof3y_4,1929
-msfabricpysdkcore/client.py,sha256=NutMuFGVHUU8CMj2mSJT5Zw1A_vQ-PRJ_yH0nqwk9aI,12536
-msfabricpysdkcore/item.py,sha256=lQODVPxqMLKUwhit7KMDFu3GahW5o7wiWA6KHxMbqu0,10188
-msfabricpysdkcore/job_instance.py,sha256=Rjv2u1XXMPVew-9gGFQLrnhzXmYfzlO9SeUvA19DDTI,2759
-msfabricpysdkcore/long_running_operation.py,sha256=PvrVEuasD9lwdJZ6ElsNwBE1G8xW5uDQ8zXcKqpOpXc,3021
-msfabricpysdkcore/onelakeshortcut.py,sha256=20AZJ79v7FvgKLYbJi0BIaawi6qMjnhqUTIlniwnVBI,2033
-msfabricpysdkcore/workspace.py,sha256=mweliwZup5XKy5yx-BGIvhZboRrtvwFYzQ4JFEICv4E,19796
-msfabricpysdkcore-0.0.2.dist-info/LICENSE,sha256=1NrGuF-zOmzbwzk3iI6lsP9koyDeKO1B0-8OD_tTvOQ,1156
-msfabricpysdkcore-0.0.2.dist-info/METADATA,sha256=cxXnkCeEtm2_xdom8fgehH8SPk9Ot7k8TTxyIAo7cEc,11321
-msfabricpysdkcore-0.0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-msfabricpysdkcore-0.0.2.dist-info/top_level.txt,sha256=3iRonu6ptDGQN4Yl6G76XGM7xbFNsskiEHW-P2gMQGY,18
-msfabricpysdkcore-0.0.2.dist-info/RECORD,,