Getting started Prerequisites

This section provides an overview of the prerequisites that you will need if working with CARML on your local machine and, for example, run the utilities/tools/Test-ModuleLocally.ps1 script.

---

Navigation

• Prerequisites
• Helper scripts

---

Prerequisites

These are

• A GitHub Account
• An active Azure subscription
• Owner (or Contributor + User Access Administrator) permissions on set subscription
• Access to the subscriptions tenant with permissions to create applications
• Installed
  • Visual Studio Code
    • + Extension: Bicep
  • Bicep CLI

    Note: Must be kept updated manually (i.e., is not updated via the Az-CLI Bicep extension)

  • Azure CLI
    • + Extension: Bicep
  • Git
    • Git Guide

    Note: If just installed, don't forget to set both your git username & password

    git config --global user.name "John Doe"
    git config --global user.email "[email protected]"

  • Windows Terminal
  • PowerShell Core
    • + Module: Az.Accounts
    • + Module: Az.Resources
    • + Module: Pester with minimum version 5.3.1
    • + Module: powershell-yaml with minimum version 0.4.2

Helper scripts

This sub-section provides you with several helper scripts that can help you set your environment up.

Check versions script

az --version
az bicep --version
bicep --version
git --version
code --version
pwsh --version

Get-Module -ListAvailable | Where-Object {
  $_.Name -in @(
    'Az.Accounts',
    'Az.Resources',
    'Pester',
    'powershell-yaml'
  )
}

Install prerequisites script (Windows 10+)

# WinGet software
winget install --id 'Git.Git'
winget install --id 'Microsoft.PowerShell'
winget install --id 'Microsoft.AzureCLI'
winget install --id 'Microsoft.Bicep'
winget install --id 'Microsoft.VisualStudioCode'
winget install --id 'GitHub.GitHubDesktop'
winget install --id 'Microsoft.WindowsTerminal'

# VS Code Extensions
code --install-extension 'ms-azuretools.vscode-bicep'
code --install-extension 'ms-vscode.PowerShell'
code --install-extension 'msazurermtools.azurerm-vscode-tools'
code --install-extension 'ms-vscode.azurecli'

# Installing or updating PowerShell modules may require elevated permissions.
Install-Module -Name 'Az.Accounts' -Scope 'CurrentUser' -Force
Install-Module -Name 'Az.Resources' -Scope 'CurrentUser' -Force
Install-Module -Name 'Pester' -Scope 'CurrentUser' -Force
Install-Module -Name 'powershell-yaml' -Scope 'CurrentUser' -Force