How to Use This Runbook
DOCUMENT CATEGORY: Runbook
SCOPE: Implementation options and configuration
PURPOSE: Guide users through deployment approach selection
MASTER REFERENCE: Microsoft Learn - Deploy Azure Local
Status: Active
This document provides detailed provisioning instructions with tabbed execution options for each step. Choose the option that best fits your environment and expertise.
Understanding the Execution Options
Each task page uses tabs so you can switch between methods without scrolling. Not every task supports all options. Only genuinely applicable methods are shown.
| Option | Best For | You Will Need |
|---|---|---|
| Manual (Azure Portal, on-site, vendor UI) | Learning, single deployments, visual preference, physical tasks | Web browser / physical access / vendor UI |
| Toolkit script (PowerShell 7) | Repeatable runs from a management workstation or a pipeline | PowerShell 7, the toolkit, and your infrastructure.yml |
Looking for full automation (IaC/CI/CD)?
The fully automated deployment instructions (Terraform, Bicep, Ansible, CI/CD pipelines) are documented separately in the Automation section. Use that guide for pipeline-driven, repeatable deployments.
Configuration File: infrastructure.yml
The toolkit scripts read one file: infrastructure.yml (schema 5). It is the only file you fill in for an environment. The master registry (config/variables/schema/master-registry.yaml) defines every key. Before you start:
- Start from a template. Copy
config/variables/templates/infrastructure.master.yml(every key), a scenario template, or the nearest worked example inconfig/variables/examples/. For one tool only, use its template inconfig/variables/templates/tools/. - Edit the values to match your environment: the Azure tenant and subscription, the resource groups, the networks, the nodes.
- Never put a secret in the file. A secret is a reference:
keyvault://<vault>/<secret>(the default),env://<VARIABLE>,file://<name>orcommand://<name>. One resolver reads every reference. No script names a vault.
# A reference, not a value
identity:
local_admin:
username: "iic-admin"
password: "keyvault://kv-iic-mgmt-01/local-admin-password"
- Check the file.
./scripts/common/infrastructure/Test-InfrastructureFile.ps1 -Path ./infrastructure.ymllists every problem at once.
Configuration reference: see Variable Management for how the variables work, and the variables reference for every key.
Execution Workflow
- Review the stage details. Understand the objectives and tasks.
- Select your tab for each step (Manual or Toolkit script).
- Complete the step following that tab's procedure.
- Validate using the verification steps provided.
- Proceed to the next step.
You can mix options throughout the runbook (for example, use the portal for some steps and scripts for others). Your tab selection persists across pages.
Script Language Support
The toolkit is PowerShell 7 only. It has no Bash scripts. Scripts that act on Azure use the Azure PowerShell modules (Az.*). A few tasks also have an Azure CLI script, written in PowerShell.
| Kind | Naming pattern | Example |
|---|---|---|
| PowerShell + Az modules | Verb-Noun.ps1 | Deploy-KeyVaults.ps1 |
| PowerShell + Azure CLI | <Verb-Noun>.azcli.ps1 | Register-ResourceProviders.azcli.ps1 |
| Orchestrated (remote) | Invoke-<Task>-Orchestrated.ps1 | Invoke-SSHConnectivity-Orchestrated.ps1 |
Every script takes the file as -InfrastructureFile (mandatory). No script takes -ConfigPath or -ConfigFile, and no script prompts.
Every script takes its values from infrastructure.yml. A test fails the build when a script carries a value that a deployment chooses (an address, a name, an ID, a region). The script status page of the toolkit says, for every task folder, whether it has a real script or a placeholder.
Authentication
Before running any scripts or accessing Azure resources, you must authenticate to Azure. This runbook assumes manual authentication for each session.
Authentication Options:
- Authentication Methods - Manual authentication for Azure PowerShell and the Azure CLI (in PowerShell).
- Appendix C: Authentication & Session Setup - Detailed authentication details and troubleshooting.
Navigation
| Previous | Up | Next |
|---|---|---|
| Purpose and Scope | Implementation Guide | Key Inputs and Variables |
Version Control
- Created: 2026-01-15 by Azure Local Cloud
- Last Updated: 2026-03-02 by Azure Local Cloud
- Version: 2.0.0
- Tags: azure-local, runbook-usage, execution-options
- Keywords: how to use, execution options, deployment approaches
- Author: Azure Local Cloud