Übersicht über Azure Developer CLI-Erweiterungen

Azure Developer CLI(azd)-Erweiterungen sind modulare Komponenten, die die Funktionalität der Azure Developer CLI erweitern. Sie ermöglichen es Ihnen, neue Funktionen hinzuzufügen, Workflows zu automatisieren und direkt über die CLI in andere Dienste zu integrieren. Verwenden Sie Erweiterungen, um auf sich entwickelnde Teamanforderungen und Azure Szenarien anzupassenazd.

Hinweis

Das Erweiterungsframework azd ist allgemein verfügbar. Einzelne Erweiterungen oder Funktionen verfügen möglicherweise über einen eigenen Vorschaustatus.

Verwalten von Erweiterungsquellen

Sie können Erweiterungen ermitteln, installieren und aktualisieren, wenn Ihre Anforderungen wachsen. Erweiterungsquellen behandeln Verteilung und Verwaltung.

  • Erweiterungsquellen sind datei- oder URL-basierte Manifeste, die Listen der verfügbaren azd Erweiterungen bereitstellen.
  • Sie können benutzerdefinierte Erweiterungsquellen hinzufügen, die eine Verbindung mit privaten, lokalen oder öffentlichen Registrierungen herstellen.
  • Erweiterungsquellen sind ein gleichwertiges Konzept für NuGet- oder Node Paket-Manager(NPM)-Feeds und müssen dem offiziellen Erweiterungsregistrierungsschema entsprechen.

azd unterstützt verschiedene Möglichkeiten zum Auflösen von Erweiterungen:

  • Die offizielle Erweiterungsquellregistrierung ist vorkonfiguriert in azd und wird unter https://aka.ms/azd/extensions/registrygehostet.
  • URL-basierte Quellen verweisen auf Remoteregistrierungsmanifeste, die Ihr Team für öffentliche oder private Verteilung hostet.
  • Dateibasierte Quellen verweisen auf lokale Registrierungsmanifeste für die Offlineverwendung oder lokale Entwicklung.
  • Die Entwicklungs- und Nightly-Registrierungen sind optionale Quellen für nicht finale und automatisch erstellte Erweiterungen des Erstanbieters. Verwenden Sie sie zum Testen von Szenarien anstelle von Produktionsworkflows.
  • Eigenständige Bundledateien stellen portable .zip Pakete für die direkte Installation aus einer lokalen Datei oder einer HTTPS-URL bereit, wenn Sie keine Registrierung hosten möchten.

azd erzwingt eine strenge Überprüfung für benutzerdefinierte Erweiterungsquellnamen. Namen müssen 1 bis 64 ASCII-Buchstaben oder Ziffern enthalten. Sie können Bindestriche (-) und Unterstriche (_) zwischen Buchstaben oder Ziffern einfügen. Namen müssen mit einem Buchstaben oder einer Ziffer beginnen und enden. azd gibt einen Fehler für ungültige Namen zurück; sie normalisiert sie nicht. Die Namen azd sind reserviert und bundle können nicht für benutzerdefinierte Quellen verwendet werden. Der Quellname muss gültig sein, wenn Sie ihn mit --source verwenden.

Die vorkonfigurierte azd-Quelle ist die offizielle Registry. Sie können sie nicht entfernen oder deren Position ändern.

Führen Sie den folgenden Befehl aus, um sich für die Entwicklungsregistrierung zu entscheiden:

# 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"

Vorsicht

In der dev-Registrierung gehostete Erweiterungen sind nicht signiert, werden nicht vom Azure-Support abgedeckt und können ohne vorherige Ankündigung geändert oder entfernt werden.

Befehle zur Erweiterungsquelle

Verwenden Sie die folgenden Befehle, um Erweiterungsquellen für Ihre azd Installation zu verwalten.

Auflisten installierter Erweiterungsquellen

azd extension source list

Hinzufügen einer neuen Erweiterungsquelle

azd extension source add -n <name> -t url -l <registry-url>
  • -l, --location: der Speicherort der Erweiterungsquelle
  • -n, --name: Der Name der Erweiterungsquelle. Verwenden Sie einen gültigen benutzerdefinierten Quellnamen.
  • -t, --type: Der Typ der Erweiterungsquelle. Unterstützte Typen sind Datei und URL.

Entfernen einer Erweiterungsquelle

azd extension source remove <name>

Sie können die vorkonfigurierte azd Quelle nicht entfernen.

Wenn ein Update einen Quellladefehler meldet, der durch einen älteren ungültigen Quellnamen verursacht ~/.azd/config.jsonwird, entfernen Sie die fehlerhafte Quelle mit azd extension source remove, und fügen Sie ihn erneut mit einem gültigen Namen hinzu.

Verwalten von Erweiterungen

Nachdem Sie Erweiterungen aktiviert und Ihre Erweiterungsquellen konfiguriert haben, installieren Sie Erweiterungen, um azd neue Funktionen hinzuzufügen. Ein Beispiel für das Arbeiten mit Erweiterungen finden Sie unter "Schnellstart : Verwenden der KI-Erweiterung".

Erweiterungen auflisten

azd extension list [flags]
  • --installed Zeigt eine Liste der installierten Erweiterungen an.
  • --source Listet nur Erweiterungen aus der angegebenen Quelle auf. Der Quellname muss ein gültiger registrierter Quellname sein.
  • --tags Filtert Erweiterungen nach Tags, z. B. KI oder Test.

Installieren einer Erweiterung

azd extension install <extension-names> [flags]

Ersetzen Sie <extension-name> durch den Namen der Erweiterung, die Sie installieren möchten.

  • -v, --version Gibt die genaue Zu installierende Version an. Diese Option akzeptiert keine Versionsbereiche oder Einschränkungen und kann bei der Installation eines eigenständigen Bündels (.zip Dateipfad oder URL) nicht verwendet werden.
  • -s, --source Gibt die Erweiterungsquelle an, die für Installationen verwendet wird. Der Quellname muss ein gültiger registrierter Quellname sein.

Um ein eigenständiges Bundle aus einer HTTPS-URL zu installieren, geben Sie den Speicherort des Bundles als Erweiterungsnamen an:

azd extension install https://example.com/extensions/example.zip
  • --all Aktualisiert alle zuvor installierten Erweiterungen, wenn angegeben.
  • -v, --version Aktualisiert eine angegebene Erweiterung auf die genaue Version, sofern angegeben. Diese Option akzeptiert keine Versionsbereiche oder Einschränkungen.
  • -s, --source Gibt die Erweiterungsquelle an, die für Installationen verwendet wird. Der Quellname muss ein gültiger registrierter Quellname sein.
  • --no-dependency-updates Verhindert Aktualisierungen von Abhängigkeiten, wenn angegeben.

Deinstallieren einer Erweiterung

azd extension uninstall <extension-name>
  • --all Entfernt alle installierten Erweiterungen, wenn angegeben.

Deklarieren erforderlicher Erweiterungen in einem Projekt

Projekte können in azure.yaml erforderliche Erweiterungen deklarieren, sodass azd die vom Projekt benötigten Erweiterungsversionen ermitteln und installieren kann. Fügen Sie Erweiterungsanforderungen unter requiredVersions.extensions hinzu und verwenden Sie latest, eine genaue Version oder eine unterstützte semantische Versionsbeschränkung.

requiredVersions:
  extensions:
    azure.ai.agents: "latest"
    contoso.azd.tagger: "^2.0.0"

Verwenden Sie Anforderungen auf Projektebene, wenn eine Vorlage von von Erweiterungen bereitgestellten Servicehosts, Lebenszyklus-Handlern, Validierungsanbietern oder Befehlen abhängt. Die vollständigen Details zur Schema- und Versionseinschränkung finden Sie unter requiredVersions.

Erweiterungsintegrationspunkte verstehen

Erweiterungen können sich auf verschiedene Arten in azd integrieren:

  • Fügen Sie Befehlsnamespaces mit Metadaten, Hilfe und Beispielen hinzu.
  • Stellen Sie Konfigurationsschemas und IntelliSense-Metadaten für Projektdateien bereit.
  • Registrieren Sie Handler für Lebenszyklusereignisse für Workflows wie Bereitstellung, Paketierung und Deployment.
  • Fügen Sie Anbieter für die benutzerdefinierte Bereitstellung, Validierung, Dienstziele und Sprach- oder Frameworkunterstützung hinzu.
  • Verfügbarmachen von MCP-Serverfunktionen (Model Context Protocol) für Agents und Entwicklertools.

Anleitungen zur Implementierung finden Sie unter Erweiterungsentwicklungskonzepte.

Verwenden von azd-Erweiterungen in Dev-Containern

Das azd Dev Container-Feature unterstützt eine extensions Option zum automatischen Installieren einer durch Trennzeichen getrennten Liste von azd Erweiterungen während des Containerbuilds. Auf diese Weise installierte Erweiterungen sind verfügbar, sobald der Container gestartet wird, wodurch manuelles Setup reduziert und azd Befehle mit den bereits installierten erforderlichen Erweiterungen ausgeführt werden können.

Um Erweiterungen automatisch zu installieren, fügen Sie die extensions Option zum azd Featureeintrag in Ihrer devcontainer.json Datei hinzu:

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

Der extensions Wert ist eine durch Trennzeichen getrennte Liste von Erweiterungsnamen azd . Die Installation erfolgt während des Containerbuilds, sodass die Erweiterungen sofort verwendet werden können, sobald der Container gestartet wird. Verwenden Sie nach dem Ändern der Erweiterungsliste den Befehl " Neu erstellen und erneut öffnen" in Visual Studio Code, um den Container mit den aktualisierten Erweiterungen neu zu erstellen.

Erfahren Sie mehr über das azd Dev Container-Feature.

Nächste Schritte

  • Last updated on