Create Extendable Bicep Params File Article #14865
Conversation
|
Test this change out locally with the following install scripts (Action run 10566240211) VSCode
Azure CLI
|
| ## What is it? | ||
| Extendable Bicep Parameter Files is a feature that allows you to extend `.bicepparam` files from another `.bicepparam` file in order to reuse parameters across multiple deployments. | ||
|
|
||
| When using extendable bicep parameter files, you will have a `base.bicepparam` file that can be used by multiple `.bicep` and `.bicepparam` files. |
There was a problem hiding this comment.
| When using extendable bicep parameter files, you will have a `base.bicepparam` file that can be used by multiple `.bicep` and `.bicepparam` files. | |
| When using extendable bicep parameter files, you will have a `bicepparam` file (for example, `base.bicepparam`, `common.bicepparam`, etc.) that can be used by multiple `.bicep` and `.bicepparam` files. |
|
|
||
| * variables: we will not have variable support in the `root.bicepparam` file to be able to read and override values in other files | ||
| ```bicep | ||
| var namePrefix = 'share' |
There was a problem hiding this comment.
It's a little odd to have such specific code samples for features that don't work. I think it's ok just to describe the limitation in words.
There was a problem hiding this comment.
So Anthony had requested I add an explanation and example for each of these bullet points - I'll follow up with him to see if this is what he is looking for or if just a quick description is good enough.
There was a problem hiding this comment.
Anthony said the examples should be helpful for users - would you be okay if I kept them in?
|
|
||
| `main.bicep` This is your main bicep file, which will define your parameters for deployment. | ||
|
|
||
| ```bicep | ||
| param namePrefix string | ||
| param location string | ||
| param symbolicName string | ||
| param tag string | ||
| ``` | ||
|
|
||
| `root.bicepparam` This is your main bicepparam file, which can be reused by multiple extended .bicepparam files and in multiple deployments. |
There was a problem hiding this comment.
Maybe I am the only one, but to me root.bicepparam file is the one being extended, not leaf.bicepparam. So when we say "can be reused by multiple extended .bicepparam files", I get confused.
There was a problem hiding this comment.
So the way I see it is that the root connects to multiple leaves - so the root can be reused multiple times into several different leaf files, which I think is also how Engin views it - should we ask the team?
There was a problem hiding this comment.
if I'm the only one with this perspective, it's fine to leave it as is
|
|
||
| * variables: we will not have variable support in the `root.bicepparam` file to be able to read and override values in other files | ||
| ```bicep | ||
| var namePrefix = 'share' |
|
|
||
| `main.bicep` This is your main bicep file, which will define your parameters for deployment. | ||
|
|
||
| ```bicep | ||
| param namePrefix string | ||
| param location string | ||
| param symbolicName string | ||
| param tag string | ||
| ``` | ||
|
|
||
| `root.bicepparam` This is your main bicepparam file, which can be reused by multiple extended .bicepparam files and in multiple deployments. |
There was a problem hiding this comment.
if I'm the only one with this perspective, it's fine to leave it as is
Added an article on using extendable bicep param files, as well as limitations.
Updated the experimental features page to link to this article too.
Microsoft Reviewers: Open in CodeFlow