Freigeben über

Konfigurieren und Nutzen von Vorlagenquellen

Die Azure Developer CLI ist auf ein leistungsfähiges Vorlagensystem ausgelegt, das die Bereitstellung und Bereitstellung von Azure-Ressourcen optimiert. Während der Entwicklung mit azd, haben Sie die Möglichkeit, entweder Eine eigene Vorlage zu erstellen, oder wählen Sie aus einer konfigurierbaren Liste vorhandener Vorlagen. In diesem Artikel erfahren Sie, wie Sie mit Vorlagenlisten arbeiten und Ihre lokale azd Installation so konfigurieren, dass verschiedene Vorlagenlistenquellen unterstützt werden.

Grundlegendes zu Vorlagenquellen

Eine azd Vorlagenquelle verweist auf eine JSON-Konfigurationsdatei, die eine Liste der verfügbaren Vorlagen und deren wesentliche Metadaten beschreibt, z. B. den Namen, die Beschreibung und den Speicherort des Vorlagenquellcodes (in der Regel ein GitHub-Repository). Wenn Sie eine Vorlagenquelle aktivieren, werden die darin definierten Vorlagen über andere Befehle zur Verfügung azd gestellt. Der folgende JSON-Codeausschnitt für die Vorlagenquelle definiert beispielsweise zwei Vorlagen:

[
  {
    "name": "Starter - Bicep",
    "description": "A starter template with Bicep as infrastructure provider",
    "repositoryPath": "azd-starter-bicep",
    "tags": ["bicep"]
  },
  {
    "name": "Starter - Terraform",
    "description": "A starter template with Terraform as infrastructure provider",
    "repositoryPath": "azd-starter-terraform",
    "tags": ["terraform"]
  }
]

Jeder Vorlageneintrag in der JSON-Konfigurationsdatei enthält die folgenden Eigenschaften:

  • Name: Der Anzeigename der Vorlage.
  • Beschreibung: Eine kurze Zusammenfassung dessen, was die Vorlage macht.
  • repositoryPath: Der Pfad zum Quellcode der Vorlage, der wie folgt lauten kann:
    • Ein vollqualifizierter URI für ein Git-Repository, z. B. „https://dev.azure.com/org/project/_git/repo".
    • "{owner}/{repo}" für GitHub-Repositories.
    • „{repo}“ für GitHub-Repositorys unter der Azure-Beispiele-Organisation.
  • Tags: Schlüsselwörter, mithilfe derer Benutzer Vorlagen mit azd init --filter <tag> und azd template list --filter <tag> filtern können.

Ein vollständiges Beispiel finden Sie in dieser JSON-Datei. Sie stellt die Quelle der Standardvorlage dar, die in azd enthalten ist.

mit azd können Sie mehrere Vorlagenquellen gleichzeitig aktivieren. Die folgenden Vorlagenquelloptionen stehen derzeit zur Auswahl:

  • awesome-azd - Eine Liste der Vorlagen aus der Awesome AZD-Galerie , die standardmäßig aktiviert ist.
  • default – Ein kleiner Satz kuratierter Vorlagen zum Veranschaulichen verschiedener Tech-Stapel.
  • datei – Ein lokaler/Netzwerkpfad, der auf eine JSON-Konfigurationsdatei der Vorlagenquelle verweist.
  • url - Ein HTTP(S)-Adresspfad, der auf eine JSON-Konfigurationsdatei der Vorlagenquelle verweist.
  • gh – Verweist auf ein GitHub-Repository.
  • ade – Verweist auf eine Azure Deployment Environment-Vorlagenliste. Erfahren Sie mehr über die Azure Developer CLI-Unterstützung für Azure-Bereitstellungsumgebungen.

Arbeiten mit Vorlagenquellen

azd stellt mehrere Befehle zum Konfigurieren von Vorlagenquellen bereit.

Verwenden Sie den azd template source list Befehl, um alle aktuell konfigurierten Vorlagenquellen auflisten:

azd template source list

Beispielausgabe mit zwei konfigurierten Vorlagenquellen:

Key          Name         Type         Location

awesome-azd  Awesome AZD  awesome-azd  https://aka.ms/awesome-azd/templates.json
default      Default      resource

Verwenden Sie den azd template source add Befehl, um eine neue Vorlagenquelle hinzuzufügen. Dieser Befehl akzeptiert die folgenden Parameter:

  • key: Der technische Name der Vorlagenquelle.
  • --type, -t: Der Vorlagenquelltyp – gültige Werte sind Datei, URL und GH für GitHub.
  • --location, -l: Der Quellspeicherort der Vorlage, bei dem es sich um einen lokalen Netzwerk- oder HTTP(S)-Web-URI handeln sollte.
  • --name, -n: Der Anzeigename der Vorlagequelle (optional, verwendet den Schlüssel, wenn er nicht angegeben ist).
azd template source add <key> --type <file-or-url-or-gh> --location <your-uri> --name <your-display-name>

Verwenden Sie den azd template source remove Befehl, um eine Vorlagenquelle zu entfernen:

azd template source remove <key>

Verwenden Sie den azd config reset Befehl, um die Vorlagenkonfiguration auf Standardeinstellungen zurückzusetzen:

azd config reset

Arbeiten mit Vorlagenlisten

Nachdem Sie Ihre Vorlagenquellen konfiguriert haben, verwenden Sie den azd template list Befehl, um die verfügbaren Vorlagen aus diesen Quellen auflisten zu können:

azd template list

Beispielsweise enthält eine Standardinstallation von azd Listen die folgenden Vorlagen aus der Vorlagequelle "awesome-azd ":

Name                                                         Source       Repository Path

Event Driven Java Application with Azure Service Bus         Awesome AZD  Azure-Samples/ASA-Samples-Event-Driven-Application
Static React Web App with Java API and PostgreSQL            Awesome AZD  Azure-Samples/ASA-Samples-Web-Application
SAP CAP on Azure App Service Quickstart                      Awesome AZD  Azure-Samples/app-service-javascript-sap-cap-quickstart
SAP Cloud SDK on Azure App Service Quickstart (TypeScript)   Awesome AZD  Azure-Samples/app-service-javascript-sap-cloud-sdk-quickstart
Java Spring Apps with Azure OpenAI                           Awesome AZD  Azure-Samples/app-templates-java-openai-springapps
WordPress with Azure Container Apps                          Awesome AZD  Azure-Samples/apptemplate-wordpress-on-ACA
Bicep template to bootstrap Azure Deployment Environments    Awesome AZD  Azure-Samples/azd-deployment-environments
Starter - Bicep                                              Awesome AZD  Azure-Samples/azd-starter-bicep
Starter - Terraform                                          Awesome AZD  Azure-Samples/azd-starter-terraform
...
# Additional templates omitted

Fügen Sie das --source Flag nur in Listenvorlagen aus einer bestimmten Quelle ein:

azd template list --source <source-name>

Um eine Vorlage aus der angezeigten Liste zu initialisieren, führen Sie den Befehl azd init aus, und geben Sie den Repositorypfad der Vorlage an:

azd init --template <path-value>

Arbeiten mit Azure-Bereitstellungsumgebungen

Die Azure Developer CLI (azd) bietet auch Unterstützung für Azure-Bereitstellungsumgebungen. Eine Azure Deployment Environment (ADE) ist eine vorkonfigurierte Sammlung von Azure-Ressourcen, die in vordefinierten Abonnements bereitgestellt werden. Auf diese Abonnements wird Azure Governance basierend auf dem Typ der Umgebung angewendet, z. B. Sandbox, Tests, Stagingprozess oder Produktion. Mit Azure-Bereitstellungsumgebungen können Sie Unternehmenssicherheitsrichtlinien erzwingen und einen kuratierten Satz vordefinierter Infrastruktur als Codevorlagen (IaC) bereitstellen.

Die ADE-Integration geht über den Rahmen dieses Artikels hinaus. Erfahren Sie mehr über das Konfigurieren der ade Unterstützung in der Dokumentation zur Azure Developer CLI für Azure-Bereitstellungsumgebungen .

Nächste Schritte

Azure Developer CLI-Unterstützung für Azure Deployment EnvironmentsTemplate list reference

  • Last updated on