AgentSkillsCN

azure-deployment-preflight

在部署 Azure Bicep 模板之前,进行全面的预检验证,包括模板语法校验、模拟执行分析以及权限检查。在每次部署 Azure 前,使用此技能预览变更、识别潜在问题,并确保部署顺利进行。当用户提及“部署到 Azure”、“验证 Bicep 文件”、“检查部署权限”、“预览基础设施变更”、“运行模拟执行”或“为 azd 预配做准备”时,即可激活此技能。

SKILL.md
--- frontmatter
name: azure-deployment-preflight
description: Performs comprehensive preflight validation of Bicep deployments to Azure, including template syntax validation, what-if analysis, and permission checks. Use this skill before any deployment to Azure to preview changes, identify potential issues, and ensure the deployment will succeed. Activate when users mention deploying to Azure, validating Bicep files, checking deployment permissions, previewing infrastructure changes, running what-if, or preparing for azd provision.

Azure Deployment Preflight Validation

This skill validates Bicep deployments before execution, supporting both Azure CLI (az) and Azure Developer CLI (azd) workflows.

When to Use This Skill

  • Before deploying infrastructure to Azure
  • When preparing or reviewing Bicep files
  • To preview what changes a deployment will make
  • To verify permissions are sufficient for deployment
  • Before running azd up, azd provision, or az deployment commands

Quick Pre-flight Checks

Run these checks BEFORE any deployment to avoid mid-deployment failures:

  1. Tools installed: az, azd, docker, bicep
  2. Authentication valid: az account show and azd auth login
  3. Subscription quotas sufficient: Check resource limits
  4. Docker daemon running (for container deployments)
bash
# Verify tools
az --version
azd version
bicep --version
docker info

# Verify authentication
az account show
azd auth login --check-status

Validation Process

Follow these steps in order. Continue to the next step even if a previous step fails—capture all issues in the final report.

Step 1: Detect Project Type

Determine the deployment workflow by checking for project indicators:

  1. Check for azd project: Look for azure.yaml in the project root

    • If found → Use azd workflow
    • If not found → Use az CLI workflow
  2. Locate Bicep files: Find all .bicep files to validate

    • For azd projects: Check infra/ directory first, then project root
    • For standalone: Use the file specified by the user or search common locations (infra/, deploy/, project root)
  3. Auto-detect parameter files: For each Bicep file, look for matching parameter files:

    • <filename>.bicepparam (Bicep parameters - preferred)
    • <filename>.parameters.json (JSON parameters)
    • parameters.json or parameters/<env>.json in same directory

Step 1.5: Validate azure.yaml (azd projects only)

For azd projects, validate the azure.yaml configuration using the Azure MCP azd tool:

javascript
const validation = await azure-azd({
  command: "validate_azure_yaml",
  parameters: { path: "./azure.yaml" }
});

What to capture:

  • Schema validation errors
  • Invalid service configurations
  • Missing required fields

If validation fails, include errors in the report and continue to Step 2.

Step 2: Validate Bicep Syntax

Run Bicep CLI to check template syntax before attempting deployment validation:

bash
bicep build <bicep-file> --stdout

What to capture:

  • Syntax errors with line/column numbers
  • Warning messages
  • Build success/failure status

If Bicep CLI is not installed:

  • Note the issue in the report
  • Continue to Step 3 (Azure will validate syntax during what-if)

Step 3: Run Preflight Validation

Choose the appropriate validation based on project type detected in Step 1.

For azd Projects (azure.yaml exists)

Use azd provision --preview to validate the deployment:

bash
azd provision --preview

If an environment is specified or multiple environments exist:

bash
azd provision --preview --environment <env-name>

For Standalone Bicep (no azure.yaml)

Determine the deployment scope from the Bicep file's targetScope declaration:

Target ScopeCommand
resourceGroup (default)az deployment group what-if
subscriptionaz deployment sub what-if
managementGroupaz deployment mg what-if
tenantaz deployment tenant what-if

Run with Provider validation level first:

bash
# Resource Group scope (most common)
az deployment group what-if \
  --resource-group <rg-name> \
  --template-file <bicep-file> \
  --parameters <param-file> \
  --validation-level Provider

# Subscription scope
az deployment sub what-if \
  --location <location> \
  --template-file <bicep-file> \
  --parameters <param-file> \
  --validation-level Provider

# Management Group scope
az deployment mg what-if \
  --location <location> \
  --management-group-id <mg-id> \
  --template-file <bicep-file> \
  --parameters <param-file> \
  --validation-level Provider

# Tenant scope
az deployment tenant what-if \
  --location <location> \
  --template-file <bicep-file> \
  --parameters <param-file> \
  --validation-level Provider

Fallback Strategy:

If --validation-level Provider fails with permission errors (RBAC), retry with ProviderNoRbac:

bash
az deployment group what-if \
  --resource-group <rg-name> \
  --template-file <bicep-file> \
  --validation-level ProviderNoRbac

Note the fallback in the report—the user may lack full deployment permissions.

Step 4: Capture What-If Results

Parse the what-if output to categorize resource changes:

Change TypeSymbolMeaning
Create+New resource will be created
Delete-Resource will be deleted
Modify~Resource properties will change
NoChange=Resource unchanged
Ignore*Resource not analyzed (limits reached)
Deploy!Resource will be deployed (changes unknown)

For modified resources, capture the specific property changes.

Step 5: Generate Report

Create a Markdown report file in the project root named:

  • preflight-report.md

Use the template structure from references/REPORT-TEMPLATE.md.

Report sections:

  1. Summary - Overall status, timestamp, files validated, target scope
  2. Tools Executed - Commands run, versions, validation levels used
  3. Issues - All errors and warnings with severity and remediation
  4. What-If Results - Resources to create/modify/delete/unchanged
  5. Recommendations - Actionable next steps

Required Information

Before running validation, gather:

InformationRequired ForHow to Obtain
Resource Groupaz deployment groupAsk user or check existing .azure/ config
SubscriptionAll deploymentsaz account show or ask user
LocationSub/MG/Tenant scopeAsk user or use default from config
Environmentazd projectsazd env list or ask user

If required information is missing, prompt the user before proceeding.

Error Handling

See references/ERROR-HANDLING.md for detailed error handling guidance.

Key principle: Continue validation even when errors occur. Capture all issues in the final report.

Error TypeAction
Not logged inNote in report, suggest az login or azd auth login
Permission deniedFall back to ProviderNoRbac, note in report
Bicep syntax errorInclude all errors, continue to other files
Tool not installedNote in report, skip that validation step
Resource group not foundNote in report, suggest creating it

Tool Requirements

This skill uses the following tools:

  • Azure CLI (az) - Version 2.76.0+ recommended for --validation-level
  • Azure Developer CLI (azd) - For projects with azure.yaml
  • Bicep CLI (bicep) - For syntax validation
  • Azure MCP Tools - For documentation lookups and best practices

Azure MCP azd Tools

Use the Azure MCP server's azd tools (azure-azd) for additional validation:

CommandDescription
validate_azure_yamlValidates azure.yaml against official JSON schema
project_validationComprehensive project validation before deployment
error_troubleshootingDiagnose and troubleshoot azd errors

Validate azure.yaml before running azd provision --preview:

javascript
const validation = await azure-azd({
  command: "validate_azure_yaml",
  parameters: { path: "./azure.yaml" }
});

Check tool availability before starting:

bash
az --version
azd version
bicep --version

Example Workflow

  1. User: "Validate my Bicep deployment before I run it"
  2. Agent detects azure.yaml → azd project
  3. Agent validates azure.yaml using azure-azdvalidate_azure_yaml
  4. Agent finds infra/main.bicep and infra/main.bicepparam
  5. Agent runs bicep build infra/main.bicep --stdout
  6. Agent runs azd provision --preview
  7. Agent generates preflight-report.md in project root
  8. Agent summarizes findings to user

Reference Documentation