Create deployment rules
When you're working in a deployment pipeline, different stages might have different configurations. For example, each stage can have different databases or different query parameters. The development stage might query sample data from the database, while the test and production stages query the entire database.
When you deploy content between pipeline stages, you can configure deployment rules to change the content while keeping some settings intact. For example, you can define a rule for semantic model in a production stage to point to a production database instead of one in the test stage. The rule is defined in the production stage, under the appropriate semantic model. Once the rule is defined, content deployed from test to production, inherits the value as defined in the deployment rule. This rule always applies as long as it's unchanged and valid.
You can configure data source rules, parameter rules, and default lakehouse rules. The following table lists the type of items you can configure rules for, and the type of rule you can configure for each one.
| Item | Data source rule | Parameter rule | Default lakehouse rule | Details |
|---|---|---|---|---|
| Dataflow | ✅ | ✅ | ❌ | Use to determine the values of the data sources or parameters for a specific dataflow. |
| Semantic model | ✅ | ✅ | ❌ | Use to determine the values of the data sources or parameters for a specific semantic model. |
| Datamart | ✅ | ✅ | ❌ | Use to determine the values of the data sources or parameters for a specific datamart. |
| Paginated report | ✅ | ❌ | ❌ | Defined for the data sources of each paginated report. Use to determine the data sources of the paginated report. |
| Notebook | ❌ | ❌ | ✅ | Use to determine the default lakehouse for a specific notebook. |
Note
Data source rules only work when you change data sources from the same type.
Create a deployment rule
To create a deployment rule, follow the steps in this section. After you create all the deployment rules you need, deploy the semantic models with the newly created rules from the source stage to the target stage where the rules were created. Your rules don't apply until you deploy the semantic models from the source to the target stage.
In the pipeline stage you want to create a deployment rule for, select Deployment rules.
A list of items you can set rules for appear in the window. Not all items in the pipeline are listed. Only items of a type that you can create rules for are listed (dataflows, semantic model, datamarts, notebooks, and paginated reports). To find the item you want to set a rule for, use the search or filter functionalities.
Select the item you want to create a rule for. The types of rules you can create for that item are displayed. So, for example, if you're creating a rule for a dataflow, you can create a data source rule or a parameter rule. If you're creating a rule for a notebook, you can create a default lakehouse rule.
Select the type of rule you want to create, expand the list, and then select Add rule. There are two types of rules you can create:
Data source rules
From the data source list, select a data source name to be updated. Use one of the following methods to select a value to replace the one from the source stage:
Select from a list.
Select Other and manually add the new data source. You can only change to a data source from the same type.
Note
- Data source rules will be grayed out if you're not the owner of the item you're creating a rule for, or if your item doesn't contain any data sources.
- For dataflows, semantic models and paginated reports, the data source list is taken from the source pipeline stage.
- You can’t use the same data source in more than one rule.
Parameter rules Select a parameter from the list of parameters; the current value is shown. Edit the value to the value you want to take effect after each deployment.
Default lakehouse rules This rule only applies to notebooks. Select a lakehouse to connect to the notebook in the target stage and set it as its default. For more information, see Notebook in deployment pipelines.
Supported data sources for dataflow and semantic model rules
Data source rules can be defined for the following data sources:
- Azure Analysis Services (AAS)
- Azure Synapse
- SQL Server Analysis Services (SSAS)
- Azure SQL Server
- SQL server
- Odata Feed
- Oracle
- SapHana (import mode only; not direct query mode)
- SharePoint
- Teradata
For other data sources, we recommend using parameters to configure your data source.
Considerations and limitations
This section lists the limitations for the deployment rules.
To create a deployment rule, you must be the owner of the item you're creating a rule for.
Deployment rules can't be created in the development stage.
When an item is removed or deleted, its rules are deleted too. These rules can't be restored.
When you unassign and reassign a workspace to reestablish connections, rules for that workspace are lost. To use these rules again, reconfigure them.
If the data source or parameter defined in a rule is changed or removed from the item it points to in the source stage, the rule isn't valid anymore, and deployment fails.
After you deploy a paginated report with a data source rule, you can't open the report using Power BI Report Builder.
Deployment rules only take effect the next time you deploy to that stage. However, if you create rules and then compare the stages before you deploy, the comparison is done based on the rules that were created even though they didn't take effect yet.
The following scenarios aren't supported:
- Data source rules for dataflows that have other dataflows as sources.
- Data source rules for common data model (CDM) folders in a dataflow.
- Data source rules for semantic models that use dataflows as their source.
- Creating data source rules on a semantic model that uses Native query and DirectQuery together.
- Parameter rules aren't supported for paginated reports.
- Adding data source rules for semantic models and dataflows on data sources which are parametrized.