FAQ
This wiki page answers frequently asked questions (FAQs) relating to the Azure Landing Zones Bicep modules.
Some FAQ questions that relate more to the architecture are based over in the CAF docs here: Enterprise-scale architecture FAQ
Log an issue or create a pull request if you have a question that is not answered here, we are happy to help and have community contributions 👍
- Why isn't
ALZ-Bicepv1.x.x yet? - Why are some linter rules disabled via the
#disable-next-lineBicep function?
Great question! Put simply this is because Bicep itself is not on a v1.X.X release yet which means there is a possibility for larger breaking changes still to occur in Bicep itself (upstream) which will in turn mean that these changes will have to be integrated into ALZ-Bicep.
This however, does not mean you shouldn't use ALZ-Bicep or Bicep as they are fully supported and ready for production usage.
As we use GitHub releases and tags you can clone and pin to a specific version in your codebase and upgrade when you are ready and willing to do so 👍
In summary, ALZ-Bicep will go v1.x.x when Bicep itself goes v1.x.x, give or take a few weeks for us to make any changes required in ALZ-Bicep upon the release of Bicep v1.x.x 👍
There are a couple of ways you can ensure you get notified of the latest releases on the ALZ-Bicep repo.
- Configure your "Watch" settings on the repo to notify you on "Releases"
- See GitHub Docs on how to do this here
- Sign-up to and use newreleases.io, add this repo
Azure/ALZ-Bicepand select your email frequency.
In some of the ALZ-Bicep modules some of linter rules are disabled using the #disable-next-line Bicep feature. Today, this is primarily for disabling the no-loc-expr-outside-params linter rule for the, optional, telemetry module as we want to ensure this telemetry deployment is stored in the same location as specified by the location input when deploying the Bicep module, instead of in the same location as specified by parLocation as this may be different from the region targeted by the deployment to ARM.
You may also see it in some location for resources that do not require a region for deployment, like Azure Policies, so instead of making users input an additional parameter for the region, we just use the one that was targeted by the deployment to ARM when the module was deployed.
It is not recommended to disable linter rules when it can be resolved by making changes to the Bicep code. However, in some scenarios, like above, this is necessary.