Översikt över CLI-tillägg för Azure Developer

Azure Developer CLI-tillägg (azd) är modulära komponenter som utökar funktionerna i Azure Developer CLI. De gör att du kan lägga till nya funktioner, automatisera arbetsflöden och integrera med andra tjänster direkt från CLI. Använd tillägg för att skräddarsy azd för att utveckla teambehov och Azure scenarier.

Hantera tilläggskällor

Du kan identifiera, installera och uppdatera tillägg när dina krav växer. Tilläggskällor hanterar distribution och administration.

• Tilläggskällor är fil- eller URL-baserade manifest som innehåller listor över tillgängliga azd tillägg.
• Du kan lägga till anpassade tilläggskällor som ansluter till privata, lokala eller offentliga register.
• Tilläggskällor är ett motsvarande begrepp som NuGet- eller Node Správca balíkov-feeds (NPM) och måste följa det officiella tilläggsregisterschemat.

azd stöder flera sätt att lösa tillägg:

• Det officiella källregistret för tillägget är förkonfigurerat och azd finns på https://aka.ms/azd/extensions/registry.
• URL-baserade källor refererar till fjärrregistermanifest som ditt team är värd för för offentlig eller privat distribution.
• Filbaserade källor refererar till lokala registermanifest för offlineanvändning eller lokal utveckling.
• Utvecklings- och nattliga register är opt-in-källor för pågående arbete och skapar automatiskt tillägg från första part. Använd dem för testningsscenarier i stället för produktionsarbetsflöden.
• Fristående paketfiler tillhandahåller portabla .zip paket för direkt installation när du inte vill vara värd för ett register.

Namn på anpassade tilläggskällor måste innehålla 1 till 64 gemena ASCII-bokstäver eller siffror. Du kan inkludera bindestreck (-) och understreck (_) mellan bokstäver eller siffror. Namn måste börja och sluta med en bokstav eller siffra. azd returnerar ett fel för ogiltiga namn. Det normaliserar dem inte. Namnen azd och bundle är reserverade och kan inte användas för anpassade källor.

Den förkonfigurerade azd källan är det officiella registret. Du kan inte ta bort den eller ändra dess plats.

Om du vill anmäla dig till utvecklingsregistret kör du följande kommando:

# Add a new extension source name 'dev' to your `azd` configuration.
azd extension source add -n dev -t url -l "https://aka.ms/azd/extensions/registry/dev"

Kommandon för tilläggskälla

Använd följande kommandon för att hantera tilläggskällor för installationen azd .

Lista installerade tilläggskällor

azd extension source list

Lägga till en ny tilläggskälla

azd extension source add -n <name> -t url -l <registry-url>

• -l, --location: Platsen för tilläggskällan.
• -n, --name: Namnet på tilläggskällan. Använd ett giltigt anpassat källnamn.
• -t, --type: Typ av tilläggskälla. Typer som stöds är fil och URL.

Ta bort en tilläggskälla

azd extension source remove <name>

Du kan inte ta bort den förkonfigurerade azd källan.

Om en uppgradering rapporterar ett källinläsningsfel som orsakas av ett äldre ogiltigt källnamn i ~/.azd/config.jsontar du bort den felande källan med azd extension source removeoch lägger sedan till den igen med ett giltigt namn.

Hantera tillägg

När du har aktiverat tillägg och konfigurerat dina tilläggskällor installerar du tillägg för att lägga till nya funktioner i azd. Ett exempel på hur du arbetar med tillägg finns i Snabbstart – använd AI-tillägget.

Lista tillägg

azd extension list [flags]

• --installed Visar en lista över installerade tillägg.
• --source Listar endast tillägg från den angivna källan. Källnamnet måste vara ett giltigt registrerat källnamn.
• --tags Filtrerar tillägg efter taggar, till exempel AI eller test.

Installera ett tillägg

azd extension install <extension-names> [flags]

Ersätt <extension-name> med namnet på tillägget som du vill installera.

• -v, --version Anger vilken versionsbegränsning som ska tillämpas vid installation av tillägg.
• -s, --source Anger den tilläggskälla som används för installationer. Källnamnet måste vara ett giltigt registrerat källnamn.

Uppgradera ett tillägg

azd extension upgrade <extension-name>

• --all Uppgraderar alla tidigare installerade tillägg när de anges.
• -v, --version Uppgraderar ett angivet tillägg med hjälp av en versionsbegränsning, om det tillhandahålls.
• -s, --source Anger den tilläggskälla som används för installationer. Källnamnet måste vara ett giltigt registrerat källnamn.

Avinstallera ett tillägg

azd extension uninstall <extension-name>

• --all Tar bort alla installerade tillägg när de anges.

Deklarera nödvändiga tillägg i ett projekt

Projekt kan deklarera nödvändiga tillägg i azure.yaml så azd att de kan matcha och installera de tilläggsversioner som projektet behöver. Lägg till tilläggskrav under requiredVersions.extensions, och använd latest, en exakt version eller en semantisk versionsbegränsning som stöds.

requiredVersions:
  extensions:
    azure.ai.agents: ">=1.0.0"
    contoso.azd.tagger: "^2.0.0"

Använd krav på projektnivå när en mall är beroende av tjänstvärdar som tillhandahålls av tillägg, livscykelhanterare, valideringsproviders eller kommandon. Fullständig information om schema- och versionsbegränsningar finns i requiredVersions.

Förstå tilläggsintegreringspunkter

Tillägg kan integreras med azd på flera sätt:

• Lägg till kommandonamnområden med metadata, hjälp och exempel.
• Ange konfigurationsscheman och IntelliSense-metadata för projektfiler.
• Registrera livscykelhändelsehanterare för arbetsflöden som etablering, paket och distribution.
• Lägg till leverantörer för anpassad etablering, validering, tjänstmål och språk- eller ramverksstöd.
• Exponera MCP-serverfunktioner (Model Context Protocol) för agenter och utvecklarverktyg.

Vägledning för implementering finns i Tilläggsutvecklingsbegrepp.

Använda azd-tillägg i dev-containrar

Dev azd Container-funktionen stöder ett extensions alternativ för att automatiskt installera en kommaavgränsad lista över azd tillägg under containerversionen. Tillägg som är installerade på det här sättet är tillgängliga så snart containern startar, vilket minskar den manuella installationen och gör det möjligt azd för kommandon att köras med nödvändiga tillägg som redan är installerade.

Om du vill installera tillägg automatiskt lägger du till extensions alternativet i funktionsposten azd i devcontainer.json filen:

{
    "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"
        }
    }
}

Värdet extensions är en kommaavgränsad lista med tilläggsnamn azd . Installationen sker under containerbygget, så tilläggen är redo att användas så snart containern startar. När du har ändrat tilläggslistan använder du kommandot Återskapa och öppna igen i Dev Container i Visual Studio Code för att återskapa containern med de uppdaterade tilläggen.

Läs mer om azd Dev Container Feature.

Nästa steg

• Snabbstart: Använda AI-tillägget
• Begrepp för tilläggsutveckling
• Snabbstart: Skapa ett azd-exempeltillägg
• Readme för tilläggsramverket