Azure YAML Editor

Edit your azure.yaml configuration visually with schema-driven forms, real-time validation, and live YAML preview. No need to write YAML manually.

View Reference Docs Get Started
The Azure YAML Editor provides a visual interface for editing your configuration

Key Features

🗂️
Visual Navigation
Navigate your azure.yaml structure with an intuitive tree sidebar. Jump to any section instantly.
📝
Schema-Driven Forms
Edit configuration using smart forms that validate as you type. No need to remember YAML syntax.
👁️
Live YAML Preview
See your changes in real-time with a synchronized YAML preview. Switch between Form and YAML views.
✅
Real-Time Validation
Get instant feedback on configuration errors. Validation highlights issues before you save.
⚡
Quick Actions
Add services, import configurations, and export your azure.yaml with one-click actions.
⌨️
Command Palette
Access all editor features quickly with keyboard shortcuts. Press Ctrl+K (or Cmd+K) to open.

How to Access the Editor

  1. Start your project with azd app run
  2. Open the dashboard URL shown in the terminal (typically http://localhost:XXXXX)
  3. Click the "Editor" tab in the dashboard navigation
  4. Start editing your azure.yaml configuration

Step-by-Step Walkthrough

1

Opening the Editor

Once your dashboard is running, navigate to the Editor tab. The editor loads your current azure.yaml file and displays it in a structured view.

The editor interface with navigation sidebar on the left
2

Navigating the Sidebar

Use the navigation sidebar to browse your configuration structure. Click on any section (like services, resources, or individual service names) to jump directly to that part of your configuration.

Navigate your configuration structure with the sidebar
3

Editing with Forms

Switch to the Form view to edit properties using intuitive form fields. The editor provides dropdowns, text inputs, and checkboxes based on the schema. Changes are validated in real-time as you type.

Edit configuration using smart forms that validate as you type
4

Viewing YAML Preview

Toggle the Preview pane to see the YAML representation of your changes. The preview updates in real-time as you edit in the form view. You can also switch to YAML view to edit directly if you prefer.

View your changes in real-time with synchronized YAML preview
5

Using Validation

The editor validates your configuration against the schema in real-time. Errors and warnings are highlighted, and you'll see a validation summary panel showing all issues. Fix errors before saving to ensure your configuration is valid.

Get instant feedback on configuration errors
6

Quick Actions and Shortcuts

Use the quick actions bar to add services, import configurations, or export your azure.yaml. Press Ctrl+K (or Cmd+K on Mac) to open the command palette for quick access to all features.

Quick actions for common tasks
Command palette for keyboard-driven navigation
7

Saving Your Changes

When you're ready, click the Save button to write your changes to the azure.yaml file. The editor will validate your configuration one final time before saving. If there are errors, you'll be prompted to fix them first.

Tips & Best Practices

💡 Use the Preview Pane

Keep the preview pane open while editing to see how your changes translate to YAML. This helps you learn the structure and catch formatting issues early.

✅ Fix Validation Errors Early

Address validation errors as you go. The editor highlights issues in real-time, making it easy to fix problems before they compound.

⌨️ Learn Keyboard Shortcuts

Use Ctrl+K to open the command palette and discover all available shortcuts. This speeds up your workflow significantly.

Learn More

azure.yaml Reference
Complete reference documentation for all azure.yaml options
Quick Start Guide
Get started with azd app in under 5 minutes