Szybki start: tworzenie przykładowego rozszerzenia azd

W tym przewodniku Szybki start utworzysz przykładowe rozszerzenie interfejsu wiersza poleceniaazd dla deweloperów Azure o nazwie Contoso Resource Tagger. Używasz rozszerzenia deweloperskiego azd do wygenerowania szkieletu projektu w języku Go, dodania polecenia niestandardowego i lokalnego uruchomienia rozszerzenia. Utworzone przykładowe rozszerzenie to punkt wyjścia dla innych artykułów w tej sekcji, który pokazuje, jak dodawać możliwości, komunikować się z azd, dodać serwer MCP (Model Context Protocol) i opublikować swoją pracę.

Aby poznać pojęcia związane z programowaniem rozszerzeń przed rozpoczęciem, zobacz Pojęcia dotyczące programowania rozszerzeń.

Uwaga / Notatka

Platforma azd rozszerzeń jest ogólnie dostępna. Poszczególne rozszerzenia lub możliwości mogą mieć własny stan wersji zapoznawczej.

Wymagania wstępne

azd domyślnie zawiera oficjalne źródło rozszerzeń. Można również instalować rozszerzenia z opartych na adresach URL lub opartych na plikach źródeł, lokalnych rejestrów programistycznych, opt-in development lub nocnych rejestrów i przenośnych .zip pakietów. Aby uzyskać szczegółowe informacje, zobacz Pojęcia dotyczące programowania rozszerzeń.

Wskazówka

azd Jeśli projekt zależy od hostów, dostawców, walidacji, procedur obsługi cyklu życia lub poleceń, zadeklaruj te wymagane rozszerzenia z azure.yaml ograniczeniami wersji. Aby uzyskać szczegółowe informacje, zobacz requiredVersions.

Instalowanie rozszerzenia dewelopera

azd Rozszerzenie dla deweloperów (microsoft.azd.extensions) zawiera polecenia azd x, których używa się do tworzenia rozszerzeń.

  1. Zainstaluj rozszerzenie dewelopera z oficjalnego źródła rozszerzenia:

    azd extension install microsoft.azd.extensions

  2. Sprawdź, czy rozszerzenie jest zainstalowane:

    azd extension list --installed

    Rozszerzenie dewelopera rejestruje zestaw poleceń w przestrzeni nazw x. Uruchom polecenie azd x , aby wyświetlić dostępne polecenia.

Utwórz szkielet przykładowego rozszerzenia

azd x init Użyj polecenia , aby utworzyć szkielet nowego projektu rozszerzenia.

  1. Utwórz i przejdź do katalogu dla rozszerzeń:

    mkdir azd-extensions
cd azd-extensions

  2. Zainicjuj repozytorium git i utwórz początkowe zatwierdzenie. Polecenie azd x init wymaga, aby folder rozszerzenia był śledzony przez narzędzie git:

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

  3. Uruchom polecenie azd x init, aby utworzyć szkielet rozszerzenia:

    azd x init

  4. Po wyświetleniu monitu podaj następujące wartości:

    Podpowiedź Wartość
    Identyfikator rozszerzenia contoso.azd.tagger
    Wyświetlana nazwa Contoso Resource Tagger
    Description Standardize and report Azure resource tags for an azd project.
    Namespace tagger
    Capabilities Custom commands
    Język Go

Polecenie tworzy szkielet rozszerzenia, kompiluje początkowe pliki binarne, pakuje rozszerzenie, publikuje je w lokalnym źródle rozszerzenia i instaluje je lokalnie w celu natychmiastowego użycia.

Eksplorowanie struktury projektu

Polecenie azd x init generuje projekt z następującymi plikami klucza:

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

Najważniejsze pliki to:

  • extension.yaml: definiuje metadane, możliwości i polecenia dla rozszerzenia. Aby dowiedzieć się więcej, zobacz Definiowanie manifestu rozszerzenia.
  • main.go: punkt wejścia, który uruchamia główne polecenie rozszerzenia.
  • build.shi build.ps1: Międzyplatformowe skrypty kompilacji, które kompilują oddzielny plik binarny dla każdej obsługiwanej platformy (Linux, Windows i macOS).
  • CHANGELOG.md: Dokumentuje zmiany między wersjami i udostępnia informacje o wydaniu podczas publikowania.

Dodawanie polecenia niestandardowego

show Dodaj polecenie, które wyświetla powitanie, aby sprawdzić, czy rozszerzenie działa. Dokładny układ pliku zależy od szablonu początkowego, ale wzorzec jest taki sam: zdefiniuj polecenie Cobra i zarejestruj go w głównym poleceniu.

  1. internal/cmd W katalogu utwórz plik o nazwie show.go o następującej zawartości:

    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. Zarejestruj polecenie w poleceniu głównym. W pliku internal/cmd/root.go dodaj następujący wiersz pod koniec pliku, po pozostałych funkcjach AddCommand:

    rootCmd.AddCommand(newShowCommand())

Uruchamianie rozszerzenia

Przed uruchomieniem rozszerzenia spakuj je i opublikuj w lokalnym źródle rozszerzenia, aby zarejestrować zmiany.

  1. Spakuj rozszerzenie:

    azd x pack

  2. Opublikuj rozszerzenie, aby go zarejestrować:

    azd x publish

  3. Uruchom nowe polecenie:

    azd tagger show

    Dane wyjściowe przypominają następujący przykład:

    Hello from the Contoso Resource Tagger extension!

Masz teraz działające rozszerzenie, na którym możesz budować.

Obserwowanie zmian podczas programowania

Zamiast ręcznie uruchamiać azd x pack i azd x publish po każdej zmianie, użyj polecenia azd x watch , aby automatycznie skompilować i zainstalować rozszerzenie podczas opracowywania.

  1. W katalogu rozszerzeń uruchom obserwatora:

    azd x watch

  2. W drugim terminalu uruchom polecenie , aby przetestować zmiany w miarę ich wprowadzania:

    azd tagger show

Aby ręcznie skompilować rozszerzenie zamiast używać obserwatora, uruchom polecenie azd x build.

Uprzątnij zasoby

Po zakończeniu eksperymentowania odinstaluj przykładowe rozszerzenie:

azd extension uninstall contoso.azd.tagger

Treści powiązane

Aby kontynuować tworzenie przykładowego rozszerzenia, zobacz następujące artykuły. Każdy artykuł jest niezależny, więc można je wykonać w dowolnej kolejności:

  • Last updated on