Freigeben über

Übersicht über Azure Developer CLI-Vorlagen

Azure Developer CLI(azd)-Vorlagen sind normale Coderepositorys, die Beispielanwendungscode sowie azd Konfigurations- und Infrastrukturdateien enthalten. azd Mithilfe von Vorlagen können Sie Azure-Ressourcen bereitstellen, Ihre Anwendung bereitstellen, CI/CD-Pipelines konfigurieren und vieles mehr. Sie können entweder eigene Vorlagen erstellen oder mit einer vorhandenen Vorlage aus einem Vorlagen-Repository wie Awesome AZD beginnen. In diesem Artikel erfahren Sie mehr über die folgenden Konzepte:

  • So ermöglichen Ihnen azd Vorlagen die Bereitstellung und den Einsatz von App-Ressourcen
  • Wie azd Vorlagen strukturiert sind
  • So entscheiden Sie, ob Sie eine vorhandene Vorlage verwenden oder eine vorlage erstellen möchten
  • Erkunden Sie vorhandene azd Startvorlagen

Gründe für die Verwendung von Azure Developer CLI-Vorlagen

Entwickler stehen häufig vor vielen zeitaufwendigen und herausfordernden Aufgaben, wenn sie ordnungsgemäß gestaltete und konfiguriert umgebungsbewusst Apps für die Cloud erstellen. Teams müssen in diesen Umgebungen viele verschiedene Bedenken berücksichtigen, z. B. das Erstellen von Ressourcen, das Anwenden von Konfigurationen, das Einrichten von Überwachung und Protokollierung, das Erstellen von CI/CD-Pipelines und andere Aufgaben. azd Vorlagen reduzieren und optimieren diese Verantwortlichkeiten, um dem Entwickler auf dem Weg von der lokalen Entwicklung zu einer erfolgreich bereitgestellten App in Azure zu helfen.

Angenommen, Sie arbeiten bei einem Unternehmen, das eine Ticketverwaltungs- und Kundenkommunikationsplattform betreibt, die die folgenden Azure-Ressourcen erfordert:

  • Zwei App-Dienstinstanzen und ein App Service-Plan zum Hosten einer Front-End-Web-App und back-End-API
  • Eine Key Vault-Instanz zum Speichern sicherer App-Geheimnisse
  • Eine Cosmos DB-Datenbank zum dauerhaften Speichern von App-Daten
  • Azure Monitor-Ressourcen wie Application Insights-Dashboards
  • Eine Service Bus-Instanz zum Verwalten von skalierbarem Messaging
  • CI/CD-Pipelines, um sicherzustellen, dass Änderungen zuverlässig durch einen automatisierten und reproduzierbaren Prozess implementiert werden können.

Anstatt von Grund auf zu beginnen, können Sie mit azd vorhandene Architekturvorlagen nutzen, um die meisten Ressourcen für Sie bereitzustellen und bereitzumachen. Das Entwicklungsteam kann sich dann auf das Erstellen der App konzentrieren und kleinere Anpassungen an der Vorlagenarchitektur vornehmen.

Funktionsweise von Azure Developer CLI-Vorlagen

Azure Developer CLI-Vorlagen sind darauf ausgelegt, mit azd-Befehlen wie azd init und azd up zu arbeiten. Die Vorlagen umfassen Konfigurations- und Infrastruktur-as-Code-Dateien (IaC), die von den Befehlen verwendet werden, um Aufgaben wie die Bereitstellung von Azure-Ressourcen auszuführen und den App-Code für sie bereitzustellen.

Ein typischer azd Workflow mit einer vorhandenen Vorlage umfasst beispielsweise die folgenden Schritte:

  1. Führen Sie den azd init Befehl mit dem --template Parameter aus, um eine vorhandene Vorlage von GitHub nach unten zu klonen.

    azd init --template todo-nodejs-mongo

  2. Führen Sie den azd auth login Befehl aus, um sich bei Ihrem Azure-Abonnement zu authentifizieren.

    azd auth login

  3. Ausführen des Befehls azd up, um die Vorlagenressource in Azure bereitzustellen. Der azd up Befehl nutzt die Konfigurations- und Infrastruktur-as-Code-Dateien (IaC) in Ihrer Vorlage, um Azure-Ressourcen bereitzustellen und Ihre Anwendung für diese Ressourcen bereitzustellen.

    azd up

  4. Nachdem Ihre Umgebung in Azure eingerichtet wurde, können Sie die Anwendungsfeatures oder Azure-Ressourcenvorlagen lokal ändern und dann erneut ausführen azd up , um Ihre Änderungen bereitzustellen.

Erkunden der Azure Developer CLI-Vorlagenstruktur

azd Vorlagen sind Standardcoderepositorys mit einigen zusätzlichen Ressourcen. Alle azd Vorlagen verwenden eine ähnliche Dateistruktur basierend auf azd Konventionen:

  • infra-Ordner- Enthält die alle Bicep- bzw. Terraform-Infrastructure-as-Code-Dateien für die azd-Vorlage. azd führt diese Dateien aus, um die Azure-Ressourcen zu erstellen, die zum Hosten Ihrer App erforderlich sind.
  • azure.yaml datei – Eine Konfigurationsdatei, die Quellcodeordner in Ihrem Projekt Azure-Ressourcen zuordnet, die im Ordner für die infra Bereitstellung definiert sind. Sie können z. B. einen API-Dienst und einen Web-Front-End-Dienst in separaten Ordnern definieren und diesen verschiedenen Azure-Ressourcen für die Bereitstellung zuordnen.
  • .azure Ordner – Enthält wichtige Azure-Konfigurationen und Umgebungsvariablen, z. B. den Speicherort zum Bereitstellen von Ressourcen oder anderen Abonnementinformationen.
  • src Ordner – Enthält den gesamten bereitstellbaren App-Quellcode. Einige azd Vorlagen schließen den src Ordner aus und stellen nur Infrastrukturressourcen bereit, damit Sie Ihren eigenen Anwendungscode hinzufügen können.

Eine allgemeine azd Vorlage kann beispielsweise mit der folgenden Ordnerstruktur übereinstimmen:

Screenshot: Azure Developer CLI-Vorlagenstruktur

azd Vorlagen enthalten optional auch einen oder mehrere der folgenden Ordner:

  • .github folder – Enthält die CI/CD-Workflow-Dateien für GitHub Actions, den Standard CI/CD-Anbieter von azd.
  • .azdo ordner – Wenn Sie Azure Pipelines für CI/CD verwenden möchten, definieren Sie die Workflowkonfigurationsdateien in diesem Ordner.
  • .devcontainer folder – Ermöglicht ihnen das Einrichten einer Dev Container-Umgebung für Ihre Anwendung.

Beginnen Sie mit einer vorhandenen Vorlage, oder erstellen Sie eigene Vorlagen.

Es gibt zwei Hauptansätze für das Arbeiten mit azd Vorlagen:

  • Beginnen Sie mit einer vorhandenen azd Vorlage.
    • Dies ist eine gute Wahl, wenn Sie gerade mit azd anfangen oder nach einer Vorlage suchen, auf der Sie eine neue App mit einer ähnlichen Architektur und ähnlichen Frameworks aufbauen können.
  • Konvertieren sie ein vorhandenes Projekt in eine azd Vorlage.
    • Dies ist eine gute Wahl, wenn Sie bereits über eine vorhandene App verfügen, sie aber mit azd Funktionen kompatibel machen möchten.

In den folgenden Abschnitten finden Sie weitere Informationen zu diesen beiden Optionen.

Beginnen mit einer vorhandenen Vorlage

Eine breite Auswahl an azd Vorlagen steht im Vorlagenkatalog "awesome-azd " zur Verfügung. Diese Vorlagen stellen Infrastruktur- und Anwendungscode für verschiedene Entwicklungsszenarien, Sprachframeworks und Azure-Dienste bereit. Wenn Sie eine Vorlage finden, die mit Ihrem lokalen Anwendungsstapel oder Ihrer gewünschten Architektur übereinstimmt, können Sie den Vorlagencode durch Ihren eigenen erweitern und ersetzen.

Die folgenden azd Vorlagen bieten z. B. Ausgangspunkte für allgemeine App-Architekturen und Frameworks:

Schablone App-Host Technologiestapel
React Web App mit C#-API und MongoDB in Azure Azure App Service Azure Cosmos DB für NoSQL, Bicep
React Web App mit C#-API und SQL-Datenbank in Azure Azure App Service Azure SQL-Datenbank, Bicep
Statische React Web App + Funktionen mit C#-API und SQL-Datenbank in Azure Azure Static Web Apps, Azure Functions Azure SQL-Datenbank, Bicep

Erstellen einer neuen azd Vorlage für Ihre App

Sie können eine vorhandene App auch in eine azd Vorlage konvertieren, um das Repository mit Bereitstellungs- und Implementierungsfunktionen zu verbessern. Dieser Ansatz ermöglicht die meisten Kontrolle und erzeugt eine wiederverwendbare Lösung für zukünftige Entwicklungsarbeiten an der App. Die allgemeinen Schritte zum Erstellen Einer eigenen Vorlage lauten wie folgt:

  • Initialisieren Sie die Projektvorlage mit azd init.
  • Erstellen Sie die Bicep- oder Terraform-Infrastruktur als Codedateien im infra Ordner.
  • Aktualisieren Sie die azure.yaml Datei, um die App-Dienste mit den Azure-Ressourcen zu verknüpfen.
  • Bereitstellen mit azd up

Die folgenden Ressourcen enthalten weitere Informationen zum Erstellen eigener Vorlagen:

Richtlinien für die Verwendung von azd Vorlagen

Bitte beachten Sie, dass jede Vorlage, die Sie mit Azure Developer CLI verwenden, von seinem jeweiligen Besitzer (möglicherweise Microsoft) gemäß der Vereinbarung lizenziert wird, die die Vorlage begleitet. Es liegt in Ihrer Verantwortung, zu bestimmen, welche Lizenz für jede Vorlage gilt, die Sie verwenden möchten.

Microsoft ist nicht für Nicht-Microsoft-Vorlagen verantwortlich und zeigt diese Vorlagen nicht auf Sicherheits-, Datenschutz-, Kompatibilitäts- oder Leistungsprobleme an. Die Vorlagen, die Sie mit Azure Developer CLI verwenden, einschließlich der von Microsoft bereitgestellten, werden von keinem Microsoft-Supportprogramm oder -Dienst unterstützt. Alle von Microsoft bereitgestellten Vorlagen werden OHNE Jegliche Garantie bereitgestellt.

Nächste Schritte

Auswählen und Bereitstellen einer Vorlage