Skip to main content

Configuration config

The general configuration that is used to generate the objects with the requested settings.

Fabric Configuration

The configuration needed to build the model

NameTypeDescription
EnvironmentStringEnvironment (PRD, TST, ACC, DEV) used in Azure Devops pipelineAn automated "conveyor belt" that moves data from one place to another or performs a task automatically.
EnvironmentDescriptionStringLonger name for the environment like Production
ServiceConnectionStringName of the service connection in Azure DevOps
VsSolutionNameStringFilename of the Visual Studio solution
ApiconfigfileStringFilepath to the api configuration file
MetaFolderStringPath on the Meta lakehouseA place where you store both "raw" data (like files) and "organized" data (like tables). It combines the best of a File Cabinet and a Database. in fabric for the meta data files
TenantIdStringThe tenant id where this is deployed
ApplicationClientIdStringThe application id that is used to deploy things that require a service principal for authentication.
ApplicationKeyvaultSecretStringThe secret name in the keyvault for the service principal
ColumnNamesToLowerboolAll columns generated will be lowercase (except for the system columns, those are in UPPER case
ColumnNamesAutoFixboolIf a column has special characters not suitable for delta table those will be replaced
RemoveNewLineFromScriptsbool
BronzeConnectionPrefixboolBronze objects will have a connection prefix
DataplatformFolderStringThe root dataplatform folder
TempFolderStringThe temp folder for local temp in the project.
DatabaseFolderStringFolder where the object yamlA simple way to write configurations. It's basically a list that computers can read easily. files are located
DatabaseOutputFolderStringFolder where the generated table definitions and view definitions will be saved
NotebooksFolderStringFolder where the notebook folders are located
NotebooksOutputFolderStringFolder where the generated notebooks will be saved
RequestFolderStringFolder where the requests will be saved. Useful for debugging purposes
FabricProjectNameStringThe project where the generated objects will be saved into
DimObjectPrefixStringA prefix for a dimension table in Gold. A leading '_' in the table Name is stripped before prefixing
FactObjectPrefixStringA prefix for a fact view in Gold. A leading '_' in the table Name is stripped before prefixing
HelpObjectPrefixStringA prefix for a help table in Gold (default='H'; a leading '_' in the Name is stripped before prefixing; empty means no prefix)
DimSurrogatekeyPrefixStringA prefix for a surrogate key column in Gold
TransformationObjectPrefixStringA prefix for a transformation table in Gold. A leading '_' in the table Name is stripped before prefixing
WorkspaceStringWorkspace for this environment in Fabric
KeyvaultStringKeyvault for this environment
SchemaHistoryStringHistory schema used for history tables (default='his')
FunctionAppNameStringThe name of the Azure Function used for the triggers
ResourceGroupNameStringThe Azure resource group holding the environment's resources (e.g. the function app)
McpClientIdStringApplication (client) id of the Entra app registration that MCP clients and the QUI website sign in with
McpAllowedRedirectUrisStringComma-separated redirect URIs the MCP server accepts for those clients
McpAllowedOriginsStringComma-separated browser origins (the QUI website) allowed to call the MCP server

The deploy pipeline uploads this file to the Meta lakehouse as Files/Configuration/config.yaml — unchanged apart from the deploymentThe process of "pushing a button" to make your configuration actual, working software in the cloud. stamp described below — where the wheel, the MCP server and the QUI website read it. Environment and EnvironmentDescription are what the MCP server's list_workspaces tool reports for the workspace.

Deployment stamp

NameTypeDescription
PlatformVersionStringThe EasyFabric release the platform was generated from. Injected by the release pipeline into the release artifact
DeploymentBuildIdStringAzure DevOps build/run id of the deploy that placed this platform
DeploymentCommitStringThe git commit sha that deploy ran from

These three keys are written by the pipelines and are read-only for you: never add or edit one by hand. A hand-written value is worse than no value at all, because the whole point of the stamp is that you can trust it when you are diagnosing whether a workspace matches the repo, and an invented value turns that diagnosis into a confident wrong answer. A key that is absent is correct behaviour, not a defect.

PlatformVersion and the two deployment keys answer different questions. PlatformVersion says which EasyFabric release the platform was generated from; DeploymentBuildId and DeploymentCommit identify the one deploy that placed the content currently in the workspace. Edit your own YAML after setup and deploy again, and PlatformVersion stays the same while the deployment stamp changes — that difference is exactly why both are recorded.

Fabric Lakehouse

NameTypeDescription
Lakehouse (Required)StringName of the lakehouse for the given layer
Layer (Required)FabricMedallionLayerLayer for the medallion architectureA way of organizing data into three stages: Bronze (raw), Silver (cleaned), and Gold (ready for reports).: Bronze, Silver, Gold, Meta
Workspace (Required)StringFabric Workspace name (workspace has to exist and user needs access)

Tabular Models

NameTypeDescription
Model (Required)StringName of the model (e.g. DM). Used to select the model by name in the loaders
TabularName (Required)StringName of the tabular database/model as deployed to the workspace
CompatibilityLevel (Required)NumberCompatibility level of the tabular model (e.g. 1700)
AddMembersboolInclude the Members and Groups of roles.yaml in the generated model (default false)
DatabaseSchemaString
WorkspaceString
DefaultPowerBIDataSourceVersionString
LoginTypeStringHow the tabular deploy authenticates. spn is the only supported value; any other fails the deploy.
PartitionDeploymentStringDeployPartitions (default) or RetainPartitions. Any other value fails the deploy.
RoleDeploymentStringDeployRolesAndMembers (default), DeployRolesRetainMembers or RetainRoles; see Role deployment. Any other value fails the deploy.
ModelDeploymentStringWhether the deploy touches this model at all: always (default) deploys it on every run, once deploys it only when it does not yet exist in the workspace, skip never deploys it. Any other value fails the deploy.
LakehouseString
LakehouseSourceConnectionStringName of the lakehouse connection used as the tabular datasource
datasourceConnectionStringOptional. Name of the shareable cloud connection the deployed model is bound to. The tabular deploy creates it on first use (SQL endpoint of LakehouseSourceConnection, service principal credentials) and calls BindToGateway, so the model can refresh without a manual credential step. Omit to leave the model's datasource credentials untouched.
BimFolderString
BimFileString
SourceQueryCultureString
ModelFolderString
ModelFileString
DerivedModelFileStringLinks a derived model file, resolved in the same ModelFolder
DataSourceTypeString
DataSourceNameString
DatasetString
TabularSystemFolderString
MeasureTemplateFileString
FormatStringFileString
RoleFileStringFile with the role definitions (e.g. roles.yaml)

Power BI Reports

NameTypeDescription
GroupNameStringA name for the group of reports. Used to reference this setting in Azure DevOps pipeline
FilePathStringRelative filepath to the reports.yaml config file
ReportFolderStringRelative Path to the folder with the PBIX files

Blob triggers

Defined under blobtriggers: — each entry connects an Azure storage container to a notebook that is triggered when a matching file is dropped. See Blob file trigger for the full setup.

Backups

Defined under backups: — each entry defines a backup of a layer to an Azure storage account:

NameTypeDescription
BackupNameStringName of the backup definition
EnabledboolWhether this backup runs (default=true)
StorageAccountStringAzure storage account to back up to
ContainerStringContainer in the storage account
LayerStringLayer to back up (e.g. bronze)
SchemaString[]Schema(s) to back up (e.g. [his])
TableFolderStringFolder with the object YAML files that define the tables to back up
ExceptFoldersString[]Folders to exclude

Bronze, Silver and Gold Table settings

Can be set as bronzetablesettings, silvertablesettings and goldtablesettings

NameTypeDescription
delta.enableChangeDataFeedbool
delta.autoOptimize.optimizeWritebool
delta.autoOptimize.autoCompactbool
delta.logRetentionDurationString
delta.deletedFileRetentionDurationString
spark.sql.parquet.vorder.defaultbool
spark.databricks.delta.optimizeWrite.enabledbool
spark.sql.parquet.vorder.defaultbool
delta.stats.extended.collectbool
delta.stats.extended.injectbool

Those settings are added to the table creation script when generated.