Rediger

Del via

Install or update the Azure Developer CLI

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:

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 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:

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:

  1. Add the azd feature to the devcontainer.json file in the .devcontainer folder 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...
}

  2. 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

When working with an out of date version of azd, you'll see a warning to upgrade to the latest version. Follow the instructions in the warning to update to the latest version.

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.

Next steps

Quickstart - Select and deploy an azd template

What are Azure Developer CLI templates?

Azure Developer CLI FAQ

  • Last updated on