Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Welcome to the Azure Developer CLI (azd)! Let's get started with installing and learning how to run azd.
Start by selecting your development environment. For more information about the pros and cons of the different development environment choices, see Azure Developer CLI (azd) supported environments.
For more advanced installation scenarios and instructions, see Azure Developer CLI Installer Scripts.
Note: When you install azd, the following tools are installed within azd scope (meaning they aren't installed globally) and are removed if azd is uninstalled:
- The GitHub CLI
- The Bicep CLI
Install azd
winget install microsoft.azd
Update azd
winget upgrade microsoft.azd
Uninstall azd
winget uninstall microsoft.azd
Note
On Apple Silicon Macs (M1 and M2) azd requires Rosetta 2. If Rosetta 2 is not already installed run softwareupdate --install-rosetta from the terminal.
The azd install process will automatically choose the correct binary for the architecture of your machine.
Install azd
brew install azure/azd/azd
If you're using brew to upgrade azd from a version not installed using brew, remove the existing version of azd using the uninstall script (if installed to the default location) or by deleting the azd binary manually. This will automatically install the correct version.
Update azd
brew upgrade --cask azure/azd/azd
Uninstall azd
brew uninstall azd
Install azd
curl -fsSL https://aka.ms/install-azd.sh | bash
Update azd
curl -fsSL https://aka.ms/install-azd.sh | bash
When you install azd, the following tools are installed within azd scope (meaning they aren't installed globally) and are removed if azd is uninstalled:
Uninstall azd
curl -fsSL https://aka.ms/uninstall-azd.sh | bash
Prerequisites
Before you get started using azd, ensure you have:
- Installed:
- Docker Desktop (other options coming soon.)
- Remote - Containers VS Code Extension
- An Azure account with an active subscription. Create one for free.
Install azd in a dev container
A dev container is a Docker image that includes all of the prerequisites you need to run an app on your local machine. Install azd as a feature in your dev container via the following steps:
Add the
azdfeature to thedevcontainer.jsonfile in the.devcontainerfolder at the root of your template.{ "name": "Azure Developer CLI", "image": "mcr.microsoft.com/devcontainers/python:3.10-bullseye", "features": { // See https://containers.dev/features for list of features "ghcr.io/devcontainers/features/docker-in-docker:2": { }, "ghcr.io/azure/azure-dev/azd:latest": {} } // Rest of file omitted... }Rebuild and run your dev container. In Visual Studio Code, use the command palette to execute the Rebuild and Reopen in Dev Container command.
Auto-install azd extensions
The azd Dev Container Feature supports an extensions option to automatically install a comma-separated list of azd extensions during the container build. Extensions installed this way are available as soon as the container starts, reducing manual setup and enabling azd commands to run with the required extensions already installed.
To auto-install extensions, add the extensions option to the azd feature entry in your devcontainer.json file:
{
"name": "Azure Developer CLI",
"image": "mcr.microsoft.com/devcontainers/python:3.10-bullseye",
"features": {
"ghcr.io/azure/azure-dev/azd:latest": {
"extensions": "my-ext-1,my-ext-2"
}
}
}
The extensions value is a comma-separated list of azd extension names. Installation occurs during the container build, so the extensions are ready to use as soon as the container starts. After changing the extensions list, use the Rebuild and Reopen in Dev Container command in Visual Studio Code to rebuild the container with the updated extensions.
Learn more about the azd Dev Container Feature.
Verify your installation
Verify your azd installation completed successfully by running the azd version command in a terminal:
azd version
azd prints the current version:
azd version 1.9.5 (commit cd2b7af9995d358aab33c782614f801ac1997dde)
Update the Azure Developer CLI
You can update azd using the built-in azd update command (Beta) or manually using the same method you used to install it.
Use azd update (Beta)
The azd update command detects how azd was originally installed and delegates to the appropriate update method automatically:
| Install method | What azd update does |
|---|---|
winget |
Runs winget upgrade Microsoft.Azd |
choco |
Runs choco upgrade azd |
| Install script or MSI (Windows) | Runs install-azd.ps1 with automatic backup and restore |
| Install script (Linux/macOS) | Runs install-azd.sh |
| Homebrew | Runs brew upgrade --cask azure/azd/azd |
.deb / .rpm package |
Directly downloads and replaces the binary |
Run the following command to update to the latest stable version:
azd update
Note
The azd update command is currently in Beta. Read more about alpha and beta feature support on the feature versioning and release strategy page.
Switch update channels
azd supports two update channels: stable (default) and daily. Channel switching is supported for script-based installs and Homebrew. If you installed azd via winget or choco, daily builds aren't available through those package managers — azd update will show guidance to reinstall via script first.
To switch to the daily channel and update:
azd update --channel daily
To switch back to the stable channel:
azd update --channel stable
When switching channels, azd prompts for confirmation before proceeding.
Use your package manager or install script
You can also update manually at any time using the same package manager or install script commands shown in the installation sections above. When azd is out of date, it displays a warning message with the applicable update command for your install method.
Request help
For information on how to file a bug, request help, or propose a new feature for the Azure Developer CLI, please visit the troubleshooting and support page.
