Repository Creation Process
Important
This page is for module owners only. If you are an external contributor, skip to the contribution flow.
Important
If this process is not followed exactly, it may result in your repository and any in-progress code being permanently deleted.
1. Add yourself to the Module Owners Team and Open Source orgs
If you have already completed these steps, skip to step 2.
- Open the Open Source Portal and ensure your GitHub account is linked to your Microsoft account.
- Open the Open Source Portal and ensure you are a member of the
AzureandMicrosoftorganizations. - Request access via the Azure Verified Modules (AVM) Module Contributors access package. Approval adds you to the
azure-verified-modules-module-contributorsEntra group.
Info
Until your access request is approved, you can contribute by using JIT elevation.
2. Gather repository information
You’ll need the following from the module request issue:
| Information | Description |
|---|---|
| Module name | Format: avm-<type>-<name> (e.g. avm-res-network-virtualnetwork) |
| Module owner GitHub handle | Your GitHub handle |
| Module owner display name | Firstname Lastname |
| Module description | Auto-prefixed with Terraform Azure Verified <module-type> Module for ... |
| Resource provider namespace | Resource modules only (e.g. Microsoft.Network) |
| Resource type | Resource modules only (e.g. virtualNetworks) |
| Alternative names | Optional comma-separated list |
| Secondary owner handle | Optional |
| Secondary owner display name | Optional |
3. Create the repository
Prerequisites:
- Latest Terraform CLI
- Latest Azure CLI
- Latest PowerShell Core
- GitHub CLI
Clone and prepare
cd ~
git clone "https://github.com/Azure/avm-terraform-governance"
cd ./avm-terraform-governance/tf-repo-mgmtAuthenticate
# GitHub CLI
gh auth login -h "github.com" -w -p "https" -s "delete_repo" -s "workflow" -s "read:user" -s "user:email"
# Azure CLI (if not already logged in)
az login --scope https://graph.microsoft.com/.default --allow-no-subscriptionsRun the creation script
if(!(Test-Path -Path "./scripts/New-Repository.ps1")) {
Write-Error "This script must be run from the tf-repo-mgmt directory."
exit 1
}
# Required Inputs
$moduleName = "<module name>" # e.g. avm-res-network-virtualnetwork
$moduleDisplayName = "<module description>"
$resourceProviderNamespace = "" # Leave empty for Pattern/Utility modules
$resourceType = "" # Leave empty for Pattern/Utility modules
$ownerPrimaryGitHubHandle = "<github handle>"
$ownerPrimaryDisplayName = "<display name>"
# Optional
$moduleAlternativeNames = ""
$ownerSecondaryGitHubHandle = ""
$ownerSecondaryDisplayName = ""
./scripts/New-Repository.ps1 `
-moduleName $moduleName `
-moduleDisplayName $moduleDisplayName `
-resourceProviderNamespace $resourceProviderNamespace `
-resourceType $resourceType `
-ownerPrimaryGitHubHandle $ownerPrimaryGitHubHandle `
-ownerPrimaryDisplayName $ownerPrimaryDisplayName `
-moduleAlternativeNames $moduleAlternativeNames `
-ownerSecondaryGitHubHandle $ownerSecondaryGitHubHandle `
-ownerSecondaryDisplayName $ownerSecondaryDisplayNameComplete Open Source Portal Setup
The script will pause and prompt you to configure the Open Source Portal. Follow the link in the script output.
Return to the terminal and type yes to complete repository configuration.
The script will automatically:
- Create a PR to add module metadata to the
avm-terraform-governancerepository. - Create an issue to install the
Azure Verified ModulesGitHub App.
4. Upgrade just-in-time access to JITv2
New repositories default to JIT v1. AVM repositories must be upgraded to JIT v2 and tied to the shared service-AVM-azure-verified-modules-module-owners rule, so that just-in-time elevation is governed centrally by the AVM team rather than by a repository-specific rule.
This is a one-off manual action in the Open Source Portal. You need Direct Owner access to the repository (configured in the previous step) to complete it.
Migrate the repository to JIT v2
- Open the repository overview on the Open Source Portal:
https://repos.opensource.microsoft.com/orgs/Azure/repos/<module name>. - In the right-hand sidebar, find the Improved Just-in-time (
New) panel and click Next. - Review the concepts (Rule Version, Rule, Tie) and click Next.
- Leave Require approval for elevation selected and click Upgrade
<module name>now.
This migrates the repository to JIT v2 and creates a temporary repository-scoped starter rule. Reload the page and confirm the Just-in-time elevation section now shows JIT version: JIT v2.
Tie the repository to the shared AVM rule
- On the repository overview, click Advanced JIT options, then select Propose a new tie.
- Under Propose tying a new rule to this repository, enter the Rule ID
service-AVM-azure-verified-modules-module-ownersand click Review. - Confirm the details and click Create tie.
The tie is created in a pending approval state, so the temporary repository-scoped rule stays active until the tie is approved.
Info
The pending tie must be approved by an owner of the service-AVM-azure-verified-modules-module-owners rule (an AVM core team member). Ask the AVM core team to approve it. Once approved, just-in-time elevation for the repository is governed by the shared AVM rule and the temporary starter rule can be ignored.
Remove yourself as a Direct Owner
You were added as a Direct Owner so you could perform the JIT configuration above. Once you have finished both the JIT v2 upgrade and the shared-rule tie, remove your own account so that only jaredholgate and jatracey remain as Direct Owners.
- On the Open Source Portal, open the repository’s Compliance tab.
- Under Direct owners, remove your own account, leaving only
jaredholgateandjatracey.
Info
Module owners retain day-to-day access through the azure-verified-modules-module-owners security group and just-in-time elevation, so you do not need to remain a Direct Owner.
5. Wait for the GitHub App
Once installed (usually within 24 hours), the environment sync runs automatically at 15:30 UTC on weekdays to complete the repository setup.