Rövid útmutató: Minta azd-bővítmény létrehozása

Ebben a rövid útmutatóban egy Contoso Resource Tagger nevű minta Azure fejlesztői CLI-bővítményt (azd)hoz létre. A fejlesztői bővítmény használatával azd létrehoz egy Go-projektet, hozzáad egy egyéni parancsot, és helyileg futtatja a bővítményt. A létrehozott mintabővítmény a jelen szakaszban található többi cikk kiindulópontja, amely bemutatja, hogyan adhat hozzá képességeket, hogyan kommunikálhat a Modellkörnyezeti protokoll (MCP) kiszolgálóval azd, és hogyan teheti közzé a munkáját.

A bővítményfejlesztés alapfogalmainak megismeréséhez tekintse meg a bővítményfejlesztési fogalmakat.

Megjegyzés:

A azd bővítmény keretrendszere általánosan elérhető. Az egyes bővítmények vagy képességek saját előzetes verziós állapotúak lehetnek.

Prerequisites

azd alapértelmezés szerint tartalmazza a hivatalos bővítményforrást. Bővítményeket is telepíthet URL-alapú vagy fájlalapú forrásokból, helyi fejlesztési nyilvántartásokból, opt-in fejlesztési vagy éjszakai regisztrációs adatbázisokból, valamint hordozható .zip csomagokból. További részletekért tekintse meg a bővítményfejlesztési fogalmakat.

Jótanács

Ha egy azd projekt a bővítmény által biztosított gazdagépeken, szolgáltatókon, érvényesítésen, életciklus-kezelőken vagy parancsokon múlik, a szükséges bővítményeket verziókorlátozásokkal deklarálja azure.yaml . További részletekért lásd: requiredVersions.

A fejlesztői bővítmény telepítése

A azd fejlesztői bővítmény (microsoft.azd.extensions) biztosítja a azd x bővítmények létrehozásához használt parancsokat.

  1. Telepítse a fejlesztői bővítményt a hivatalos bővítményforrásból:

    azd extension install microsoft.azd.extensions

  2. Ellenőrizze, hogy a bővítmény telepítve van-e:

    azd extension list --installed

    A fejlesztői bővítmény egy parancscsomagot regisztrál a x névtérben. Futtassa a(z) azd x parancsot az elérhető parancsok megtekintéséhez.

A mintabővítmény állványzata

azd x init A parancs használatával új bővítményprojektet hozhat létre.

  1. Hozzon létre egy könyvtárat a bővítményei számára, majd váltson át abba:

    mkdir azd-extensions
cd azd-extensions

  2. Inicializáljon egy git-adattárat, és hozzon létre egy kezdeti véglegesítést. A azd x init parancshoz a gitnek nyomon kell követnie a bővítménymappát:

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

  3. A bővítmény állványzatának létrehozásához futtassa a(z) azd x init parancsot:

    azd x init

  4. Amikor a rendszer kéri, adja meg a következő értékeket:

    Haladéktalan Érték
    Bővítmény azonosítója contoso.azd.tagger
    Megjelenített név Contoso Resource Tagger
    Description Standardize and report Azure resource tags for an azd project.
    Namespace tagger
    Képességek Custom commands
    Nyelv Go

A parancs felépíti a bővítményt, létrehozza a kezdeti bináris fájlokat, csomagolja a bővítményt, közzéteszi azt egy helyi bővítményforrásban, és helyileg telepíti azonnali használatra.

A projektstruktúra megismerése

A azd x init parancs létrehoz egy projektet a következő kulcsfájlokkal:

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

A legfontosabb fájlok a következők:

  • extension.yaml: Meghatározza a bővítmény metaadatait, képességeit és parancsait. További információ: A bővítményjegyzék definiálása.
  • main.go: A bővítmény gyökérparancsát futtató belépési pont.
  • build.shésbuild.ps1: Platformfüggetlen buildelési szkriptek, amelyek minden támogatott platformhoz (Linux, Windows és macOS) külön bináris fájlt állítanak össze.
  • CHANGELOG.md: A dokumentumok a verziók között változnak, és közzétételkor kibocsátási megjegyzéseket nyújtanak.

Egyéni parancs hozzáadása

Adjon hozzá egy show parancsot, amely üdvözlőszöveget nyomtat a bővítmény működésének ellenőrzéséhez. A fájl pontos elrendezése a kezdősablontól függ, de a minta ugyanaz: definiáljon egy Cobra-parancsot , és regisztrálja azt a gyökérparancson.

  1. A címtárban internal/cmd hozzon létre egy fájlt show.go a következő tartalommal:

    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. Regisztrálja a parancsot a gyökérparancson. A(z) internal/cmd/root.go fájlban adja hozzá a következő sort a fájl alja felé, a többi AddCommand függvény után:

    rootCmd.AddCommand(newShowCommand())

A bővítmény futtatása

A bővítmény futtatása előtt csomagolja be és tegye közzé a helyi bővítményforrásban a módosítások regisztrálásához.

  1. Csomagolja be a bővítményt:

    azd x pack

  2. Tegye közzé a bővítményt a regisztrációhoz:

    azd x publish

  3. Futtassa az új parancsot:

    azd tagger show

    A kimenet a következő példához hasonlít:

    Hello from the Contoso Resource Tagger extension!

Most már rendelkezik egy működő bővítménysel, amelyre építhet.

Változások figyelése a fejlesztés során

Ahelyett, hogy manuálisan futtatja azd x pack és azd x publish minden módosítás után, a azd x watch fejlesztés során automatikusan létrehozza és telepíti a bővítményt.

  1. A bővítménykönyvtárból indítsa el a figyelőt:

    azd x watch

  2. Egy második terminálban futtassa a parancsot a módosítások teszteléséhez a módosítások végrehajtása közben:

    azd tagger show

Ha manuálisan szeretné létrehozni a bővítményt a figyelő használata helyett, futtassa a parancsot azd x build.

Erőforrások tisztítása

A kísérletezés befejezése után távolítsa el a mintabővítményt:

azd extension uninstall contoso.azd.tagger

Kapcsolódó tartalom

A mintabővítményre való építés folytatásához tekintse meg az alábbi cikkeket. Minden cikk független, így bármilyen sorrendben elvégezheti őket:

  • Last updated on