Prerequisites
GitHub Account Link and Access
You need a GitHub account. Microsoft FTEs must use a personal GitHub account linked to their Microsoft corporate identity and join the Azure organization. External contributors can use a fork without joining the organization.
Recommended Learning
Before you start contributing to the AVM, it is highly recommended that you complete the following Microsoft Learn paths, modules & courses:
Bicep
- Deploy and manage resources in Azure by using Bicep
- Bicep file structure and syntax
- Best practices for Bicep
Git
Tooling
Required Tooling
To contribute to this project the following tooling is required:
If just installed, set your Git name and email:
git config --global user.name "John Doe" git config --global user.email "johndoe@example.com"Avm.Authoring, installed from Microsoft Artifact Registry (MAR). PowerShell 7.4 or later andMicrosoft.PowerShell.PSResourceGet1.2.0 or later are required. If needed, install the latter from PowerShell Gallery and restart PowerShell:Install-PSResource -Name Microsoft.PowerShell.PSResourceGet ` -Version 1.2.0 ` -Repository PSGallery ` -Scope CurrentUserRegister MAR once, then install the module:
Import-Module Microsoft.PowerShell.PSResourceGet -MinimumVersion 1.2.0 Register-PSResourceRepository -Name MAR ` -Uri 'https://mcr.microsoft.com' ` -ApiVersion ContainerRegistry ` -Trusted Install-PSResource -Name avm.authoring ` -Repository MAR ` -Scope CurrentUser Import-Module Avm.Authoring avm doctorTo update from MAR, repeat
Install-PSResource -Name avm.authoring -Repository MAR -Scope CurrentUser -Reinstalland start a new PowerShell session.avm updateuses PowerShell Gallery, not MAR. The module downloads and caches its pinned Bicep CLI on demand; no separate Bicep installation is needed for those commands. See initializing and updating Bicep module files.
Recommended Tooling
The following tooling/extensions are recommended to assist you developing for the project:
Visual Studio Code Extensions
- CodeTour extension for Visual Studio Code
- ARM Tools extension for Visual Studio Code
- ARM Template Viewer extension for Visual Studio Code
- PSRule extension for Visual Studio Code
- EditorConfig for VS Code
- For visibility of Bracket Pairs:
- Inside Visual Studio Code, add
editor.bracketPairColorization.enabled: true to yoursettings.json, to enable bracket pair colorization.
- Inside Visual Studio Code, add
Desktop Tooling
- GitHub Desktop
- To enhance streamlined integration during interactions with upstream repositories, GitHub Desktop will automatically configure your local git repository to use the upstream repository as a remote.