Home

Common Azure Resource Modules Library

The objective of this repository is to provide a template library that can accelerate deployments in Infrastructure as Code scenarios, such as Azure landing zones, landing zone accelerators and aspiring landing zone accelerators (workloads/applications/multi-module solutions) or individual service deployments.

This wiki describes the content of this repository, its modules, pipelines, and possible options on how to use them and how to contribute to this project.

If you're unfamiliar with Infrastructure as Code or wonder how you can use the content of this repository in your deployments, check out The context section of this wiki.

Navigation

• The context
  • CARML overview
    • The library
    • The CI environment
  • Logical layers and personas
• Getting started
  • Scenario 1: Consume module library only
  • Scenario 2: Onboard module library and CI environment
    • Check namePrefix availability
  • Scenario 3: Contribute
• The library
  • Module design
  • Module usage
• The CI environment
  • Pipeline design
    • Static validation
    • Deployment validation
    • Publishing
    • Token replacement
    • GitHub ReadMe module table update
  • Pipeline usage
• Interoperability
  • Bicep to ARM/JSON conversion
  • Register Azure DevOps pipelines
• Contribution guide
  • Contribution flow
  • Generate module Readme
  • Get formatted RBAC roles
  • Validate module locally
  • Validate modules on scale
• Solution creation
• Upgrade guideline
  • Upgrade from 0.3.1 to 0.4.0
• Known issues

---

Scope

Following, you can find an abstract overview of everything in- and out-of-scope of this repository.

In Scope

• Module library: A collection of comprehensive, reusable, Bicep-based building blocks to deploy Azure resources, that can be combined to create & orchestrate more complex, multi-module Azure solutions.
• CI environment: Pipelines to validate modules & publish the successfully validated ones to a target location, using semantic versioning. Available with both GitHub Workflows and Azure DevOps pipelines.
• Documentation: Including design principles and usage of The library and The CI environment as well as step-by-step guidelines on how to start leveraging them - see in the Getting started section.

Out of Scope

• Orchestration: Orchestrated, multi-module solutions such as workloads or applications intended for production environments.
• Real-time Updates: Modules are updated on a best effort basis by a group of committed contributors.
• Languages: Other domain-specific languages (DSL), like Terraform.

Reporting Issues

Bugs

If you find any bugs, please file an issue on the GitHub Issues page by filling out the provided template with the appropriate information.

Please search the existing issues before filing new issues to avoid duplicates.

If you are taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Feature requests

If there is a feature you would like to see in here, please file an issue or feature request on the GitHub Issues page to provide direct feedback.

---

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

---

Learn More

• PowerShell Documentation
• Microsoft Azure Documentation
• Azure Resource Manager
• Bicep
• GitHubDocs