Welcome to the Fabric Workload Development Kit. This comprehensive guide covers everything you need to know to create a custom Fabric workload for your organization. We’re here to assist you every step of the way, so please don’t hesitate to reach out with any questions. Happy developing!
[!NOTE] This particular repoistory represents the work of the next version of the Workload Development Kit (v2).
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
Microsoft Fabric is a comprehensive analytics solution designed for enterprise-level applications. This platform encompasses a wide range of services, including data engineering, real-time analytics, and business intelligence, all consolidated within a single, unified framework.
The key advantage of Microsoft Fabric is its integrated approach, that eliminates the need for distinct services from multiple vendors. Users can leverage this platform to streamline their analytics processes, with all services accessible from a single source of truth.
Microsoft Fabric provides integration and simplicity, as well as a transparent and flexible cost management experience. This cost management experience allows users to control expenses effectively by ensuring they only pay for the resources they require.
The Fabric platform is not just a tool, but a strategic asset that simplifies and enhances the analytics capabilities of any enterprise. More information about Fabric can be found in the documentation.
In Microsoft Fabric, workloads signify different components that are integrated into the Fabric framework. Workloads enhance the usability of your service within the familiar Fabric workspace, eliminating the need to leave the Fabric environment for different services. Data Factory, Data Warehouse, Power BI and Fabric Activator are some of the built-in Fabric workloads.
With the Workload Development Kit, you can create your own workload for your data applications. Publishing a Fabric Workload to the Fabric Workload Hub increases your application’s discoverability and user engagement. The Microsoft Fabric Workload Development Kit provides the necessary tools and interfaces to embed your data application into Microsoft Fabric.
For more information on what workloads can offer Microsoft partners, and for useful examples, head to our official Workload Dev Kit documentation.
You can also learn more about the new Fabric workload architecture.
To run the development enviroment locally you need the follwoing components:
If you don’t want to install all dependencies you can also create a devcontainer with the configuration provided in this repository, or create a Codespace in GitHub directly. If you use a codespace please make sure that you select at least an 8 core machine and open the Codespace in VSCode locally.
Run the setup scripts in scripts/Setup/ and configure Workload/.env.dev for your Fabric tenant and workspace.
After you have completed the initial steps you are all set to start adopting the Workload sample to your needs.
Be sure to look at what has been released with the newest version of the WDK.
Once you customize this workload, you can publish it either internally (to your own Fabric tenant) or cross-tenant (to all Fabric customers through the Workload Hub). Cross-tenant distribution goes through a Microsoft certification process; internal publishing does not.
Start with the Publishing overview to pick the scenario that fits, then work through the requirements below before submitting the Publishing Request Form.
Use these links to take a customized workload through certification and publication:
| Topic | Description |
|---|---|
| Publishing overview | The two publishing scenarios (internal vs. cross-tenant) and the end-to-end flow. |
| General publishing requirements | Baseline requirements for all workloads — Entra custom domain, app registration, manifest, hosting, and security. |
| Publishing requirements (overview) | Full set of certification requirements for Workload Hub distribution, plus prerequisites and the publishing process. |
| Publishing requirements for workloads | Workload-level functionality, reliability, compliance, and documentation standards. |
| Publishing requirements for items | Item-level UX, data handling, accessibility, and lifecycle standards. |
| Vendor attestation template | Template for the compliance attestation document referenced by AttestationUrl in your manifest. |
| Manifest overview | How to prepare the manifest package that is validated, certified, and published. |
| Validate your workload for publishing | Run the official validation tool to catch compliance issues before submission. |
| Upload / publish a workload | Step-by-step upload through the Fabric Admin Portal and workload-name registration. |
| Publishing Request Form | Submit your workload to Microsoft to move to Preview and then General Availability. |
Here are all the resources included and referenced. These documents provide additional information and can serve as a reference: