Rychlý start: Sestavení ukázkového rozšíření azd

V tomto rychlém úvodu vytvoříte ukázkové rozšíření Azure Developer CLI (azd) s názvem Contoso Resource Tagger. Pomocí rozšíření pro vývojáře azd vytvoříte základní strukturu projektu v jazyce Go, přidáte vlastní příkaz a rozšíření spustíte lokálně. Ukázkové rozšíření, které vytvoříte, je výchozím bodem pro ostatní články v této části, které ukazují, jak přidávat funkce, komunikovat s azd, přidat server protokolu Model Context Protocol (MCP) a publikovat své rozšíření.

Pokud se chcete seznámit s koncepty vývoje rozšíření před tím, než začnete, přečtěte si téma Koncepty vývoje rozšíření.

Note

Architektura azd rozšíření je obecně dostupná. Jednotlivá rozšíření nebo možnosti můžou mít svůj vlastní stav Preview.

Předpoklady

azd obsahuje ve výchozím nastavení oficiální zdroj rozšíření. Můžete také nainstalovat rozšíření ze zdrojů založených na adresách URL nebo souborů, místních vývojových registrů, vývoje výslovného souhlasu nebo nočních registrů a přenosných .zip sad. Podrobnosti najdete v tématu Koncepty vývoje rozšíření.

Tip

azd Pokud projekt závisí na hostitelích poskytovaných rozšířením, poskytovatelích, ověřování, obslužných rutinách životního cyklu nebo příkazech, deklarujte tato požadovaná rozšíření s azure.yaml omezeními verze. Podrobnosti najdete v requiredVersions.

Instalace rozšíření pro vývojáře

Vývojářské azd rozšíření (microsoft.azd.extensions) poskytuje azd x příkazy, které používáte k sestavení rozšíření.

  1. Nainstalujte rozšíření pro vývojáře z oficiálního zdroje rozšíření:

    azd extension install microsoft.azd.extensions

  2. Ověřte, že je rozšíření nainstalované:

    azd extension list --installed

    Rozšíření pro vývojáře registruje sadu příkazů v oboru názvů x. Spuštěním azd x zobrazíte dostupné příkazy.

Vygenerovat ukázkové rozšíření

Pomocí příkazu azd x init vytvořte základ nového projektu rozšíření.

  1. Vytvořte a změňte adresář pro vaše rozšíření:

    mkdir azd-extensions
cd azd-extensions

  2. Inicializuje úložiště Git a vytvoří počáteční potvrzení. Příkaz azd x init vyžaduje, aby složka rozšíření byla sledována gitem:

    git init
git commit --allow-empty -m "Initial commit"

  3. Spusťte příkaz azd x init a vytvořte kostru rozšíření:

    azd x init

  4. Po zobrazení výzvy zadejte následující hodnoty:

    Výzva Hodnota
    ID rozšíření contoso.azd.tagger
    Zobrazované jméno Contoso Resource Tagger
    Description Standardize and report Azure resource tags for an azd project.
    Namespace tagger
    Capabilities Custom commands
    Jazyk Go

Příkaz vygeneruje rozšíření, sestaví počáteční binární soubory, zabalí rozšíření, publikuje ho do místního zdroje rozšíření a nainstaluje ho místně pro okamžité použití.

Prozkoumání struktury projektu

Příkaz azd x init vygeneruje projekt s následujícími klíčovými soubory:

contoso.azd.tagger/
├── bin/                    # Contains built binaries
├── build.ps1               # Windows build script
├── build.sh                # Unix build script
├── CHANGELOG.md            # Version history and release notes
├── extension.yaml          # Extension metadata and capabilities
├── main.go                 # Entry point for the extension
├── go.mod                  # Go module definition
└── internal/               # Internal implementation code

Nejdůležitější soubory jsou:

  • extension.yaml: Definuje metadata, možnosti a příkazy pro vaše rozšíření. Další informace najdete v tématu Definování manifestu rozšíření.
  • main.go: Vstupní bod, který spouští kořenový příkaz rozšíření.
  • build.shabuild.ps1: Multiplatformní skripty sestavení, které kompilují samostatný binární soubor pro každou podporovanou platformu (Linux, Windows a macOS).
  • CHANGELOG.md: Dokumentuje změny mezi verzemi a při publikaci poskytuje poznámky k vydání.

Přidání vlastního příkazu

show Přidejte příkaz, který vytiskne pozdrav, abyste ověřili, že rozšíření funguje. Přesné rozložení souboru závisí na počáteční šabloně, ale vzor je stejný: definujte příkaz Cobra a zaregistrujte ho v kořenovém příkazu.

  1. internal/cmd V adresáři vytvořte soubor s názvem show.go s následujícím obsahem:

    package cmd

import (
    "fmt"

    "github.com/spf13/cobra"
)

func newShowCommand() *cobra.Command {
    return &cobra.Command{
        Use:   "show",
        Short: "Displays a greeting from the Contoso Resource Tagger extension.",
        RunE: func(cmd *cobra.Command, args []string) error {
            fmt.Println("Hello from the Contoso Resource Tagger extension!")
            return nil
        },
    }
}

  2. Zaregistrujte příkaz v kořenovém příkazu. Do souboru internal/cmd/root.go přidejte následující řádek do spodní části souboru za ostatní funkce AddCommand:

    rootCmd.AddCommand(newShowCommand())

Spustit rozšíření

Než rozšíření spustíte, zabalte ho a publikujte ho do místního zdroje rozšíření a zaregistrujte změny.

  1. Vytvořte balíček rozšíření:

    azd x pack

  2. Publikujte rozšíření a zaregistrujte ho:

    azd x publish

  3. Spusťte nový příkaz:

    azd tagger show

    Výstup vypadá podobně jako v následujícím příkladu:

    Hello from the Contoso Resource Tagger extension!

Teď máte funkční rozšíření, na které můžete stavět.

Sledujte změny během vývoje.

Místo ručního spouštění azd x pack a azd x publish po každé změně použijte azd x watch k automatickému sestavení a instalaci rozšíření během vývoje.

  1. V adresáři rozšíření spusťte sledovací proces:

    azd x watch

  2. V druhém terminálu spusťte příkaz k otestování změn při jejich provádění:

    azd tagger show

Chcete-li rozšíření sestavit ručně namísto použití watcheru, spusťte azd x build.

Vyčistěte zdroje

Po dokončení experimentování odinstalujte ukázkové rozšíření:

azd extension uninstall contoso.azd.tagger

Související obsah

Pokud chcete pokračovat v vytváření ukázkového rozšíření, přečtěte si následující články. Každý článek je nezávislý, takže je můžete dokončit v libovolném pořadí:

  • Poslední aktualizace v