Naming Conventions
Canonical reference: Naming Conventions (full)
Applies to: All AzureLocal repositories
Last Updated: 2026-03-17
File & Directory Naming
| Type | Convention | Pattern | Example |
|---|---|---|---|
| Directories | lowercase-with-hyphens | ^[a-z][a-z0-9-]*$ | getting-started/ |
| Markdown (docs/) | lowercase with hyphens | *.md | deployment-guide.md |
| Root files | UPPERCASE | — | README.md, CHANGELOG.md |
| PowerShell scripts | PascalCase | Verb-Noun.ps1 | Deploy-Solution.ps1 |
| Config files | lowercase-with-hyphens | — | variables.example.yml |
Azure Resource Naming
All resources follow the IIC naming patterns:
| Resource Type | Pattern | Example |
|---|---|---|
| Resource Group | rg-iic-<purpose>-<##> | rg-iic-platform-01 |
| Virtual Network | vnet-iic-<purpose>-<##> | vnet-iic-compute-01 |
| Network Security Group | nsg-iic-<purpose> | nsg-iic-compute |
| Key Vault | kv-iic-<purpose> | kv-iic-platform |
| Storage Account | stiic<purpose><##> | stiicdata01 |
| Log Analytics | law-iic-<purpose>-<##> | law-iic-monitor-01 |
Variable Naming
| Rule | Standard | Example |
|---|---|---|
| YAML sections | snake_case | azure_local, networking |
| YAML keys | snake_case | subscription_id, resource_name |
| Pattern | ^[a-z][a-z0-9_]*$ | — |
| Max length | 50 characters | — |
Git Branch Naming
| Pattern | Usage | Example |
|---|---|---|
main | Default branch | — |
feature/<description> | New features | feature/add-validation |
fix/<description> | Bug fixes | fix/config-parsing |
docs/<description> | Documentation | docs/deployment-guide |
infra/<description> | CI/CD | infra/add-pester-tests |