Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
An item definition is the structured set of files and metadata that describe how a Fabric item is constructed. A Fabric item definition includes the mandatory system files that define the item's characteristics. Different Fabric item types (Lakehouses, Notebooks, Semantic Models, Data Pipelines, Eventstreams, etc.) each have their own supported definition formats and mandatory parts.
Definition based APIs
A definition‑based API in Microsoft Fabric is a type of REST API that returns the full item definition in the response or accepts an item definition as the payload when creating or updating a Fabric item.
Definition based APIs are important because they allow for:
- Fully automated deployment of Fabric items
- Bulk migrations using export/import of item definitions
Definition based APIs include Get Item Definition, Update Item Definition, and Create Item with Definition.
Platform file
The platform file is a definition part that contains the item's metadata information.
- Create Item with definition - Respects the platform file if provided.
- Get Item Definition - Always returns the platform file.
- Update Item Definition - Accepts the platform file if provided, but only if you set a
updateMetadata=trueURL parameter. - Workspaces - Import Multiple Item Definitions (beta) - Respects the platform files if provided.
- Workspaces - Export Multiple Item Definitions (beta) - Always returns the requested platform files.
For more information, see Automatically generated system files
Definition Details for Supported Item Types
- Copy job definition
- Dataflow definition
- Eventhouse definition
- API for GraphQL definition
- Dataflow definition
- DataPipeline definition
- dbt job definition
- Eventschemaset definition
- Graph Model definition
- HLSCohort definition
- KQL Database definition
- KQL Dashboard definition
- KQL Queryset definition
- Lakehouse definition
- Mirrored Azure Databricks Catalog definition
- Mirrored database definition
- Mounted Data Factory definition
- Environment definition
- Notebook definition
- Report definition
- Semantic model definition
- Snowflake Database definition
- KQL Dashboard definition
- Eventstream definition
- Reflex definition
- Spark job definition
- Variable Library definition