Machen Sie Ihr Projekt mit der Azure Developer CLI kompatibel

Azure Developer CLI (azd) ermöglicht Entwicklern das Gerüst ihrer Anwendungen für die Cloud mithilfe von Vorlagen , die auf GitHub gehostet werden. Microsoft bietet mehrere Vorlagen für die ersten Schritte. In diesem Artikel erfahren Sie, wie Sie Ihre eigene Anwendung azd kompatibel machen.

Grundlegendes zur Vorlagenarchitektur

Das folgende Diagramm bietet einen schnellen Überblick über den Prozess zum Erstellen einer azd Vorlage:

Alle azd Vorlagen haben die gleiche Dateistruktur, basierend auf azd Konventionen. Die folgende Hierarchie zeigt die Verzeichnisstruktur, die Sie in diesem Lernprogramm erstellen.

├── .azdo                                        [ Configures an Azure Pipeline ]
├── .devcontainer                                [ For DevContainer ]
├── .github                                      [ Configures a GitHub workflow ]
├── .vscode                                      [ VS Code workspace configurations ]
├── .azure                                       [ Stores Azure configurations and environment variables ]
├── infra                                        [ Contains infrastructure as code files ]
│   ├── main.bicep/main.tf                       [ Main infrastructure file ]
│   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
│   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
└── azure.yaml                                   [ Describes the app and type of Azure resources]

Initialisieren der Vorlage

Der azd init Befehl wird verwendet, um Ihre Anwendung für die Bereitstellung und Bereitstellung der App-Ressourcen in Azure zu initialisieren. Mit diesem Befehl werden Sie aufgefordert, zwischen zwei verschiedenen Workflows auszuwählen, um eine Vorlage zu initialisieren, die in den folgenden Abschnitten beschrieben ist.

• Verwenden Sie Code im aktuellen Verzeichnis: Wählen Sie diese Option aus, um azd den Code in Ihrem Verzeichnis zu analysieren, um zu ermitteln, welche Technologien verwendet werden, z. B. die Programmiersprache, das Framework und das Datenbanksystem. azd generiert dann automatisch Vorlagenressourcen für Sie, z. B. die azure.yaml Dienstdefinitionsdatei und den infra Ordner mit Infrastruktur-as-Code-Dateien.

• Wählen Sie eine Vorlage aus: Wählen Sie diese Option aus, um eine vorhandene Vorlage als Ausgangspunkt zu verwenden. Standardmäßig azd können Sie Vorlagen aus dem Awesome AZD-Katalog durchsuchen, aber Sie können auch Eigene Vorlagenkataloge konfigurieren. Wenn Sie eine Vorlage auswählen, werden die Ressourcen dieser Vorlage ihrem vorhandenen Projektverzeichnis hinzugefügt.

Die Details zu den einzelnen Workflows werden in den folgenden Abschnitten beschrieben.

Verwenden von Code im Verzeichnis

1. Sie können die schritte weiter mit Ihrem eigenen Projekt ausführen. Wenn Sie jedoch lieber eine Beispielanwendung verwenden möchten, klonen Sie das folgende Startrepo in ein leeres Verzeichnis auf Ihrem Computer:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. Öffnen Sie das Befehlszeilentool ihrer Wahl im Stammverzeichnis des Projekts.

3. Führen Sie den azd init Befehl aus, um die Vorlage zu initialisieren.

   azd init
   

4. Wenn Sie dazu aufgefordert werden, wählen Sie die Option zum Verwenden von Code im aktuellen Verzeichnis aus. azd analysiert das Projekt und stellt eine Zusammenfassung der erkannten Dienste und empfohlenen Azure-Hostingressourcen bereit.

5. Wählen Sie "Bestätigen" aus, und initialisieren Sie die App weiter. azd generiert die folgenden Ressourcen im Projektstammverzeichnis:

   • Eine azure.yaml Datei mit entsprechenden Dienstdefinitionen.
   • Ein infra Ordner mit Infrastruktur-as-Code-Dateien zum Bereitstellen und Bereitstellen des Projekts in Azure.
   • Ein .azure Ordner mit Umgebungsvariablen, die in einer .env Datei festgelegt sind.

   Weitere Details zu diesem Erkennungs- und Generierungsprozess finden Sie weiter unten im Artikel.

6. Die generierten Dateien funktionieren wie für die bereitgestellte Beispiel-App und können auch für Ihre eigenen Apps verwendet werden. Bei Bedarf können die generierten Dateien entsprechend Ihren Anforderungen geändert werden. Beispielsweise müssen Sie die Infrastruktur-as-Code-Dateien im infra Ordner möglicherweise weiter ändern, wenn Ihre App auf Azure-Ressourcen basiert, die über diejenigen hinausgehen, die durch azdidentifiziert wurden.

7. Führen Sie den azd up Befehl aus, um Ihre App in Azure bereitzustellen und bereitzustellen.

   azd up
   

8. Wenn Sie dazu aufgefordert werden, wählen Sie das gewünschte Abonnement und den gewünschten Speicherort aus, um den Bereitstellungs- und Bereitstellungsprozess zu starten.

9. Wenn der Vorgang abgeschlossen ist, klicken Sie auf den Link in der azd Ausgabe, um die App im Browser zu öffnen.

Erkunden der Initialisierungsschritte

Wenn Sie den Code im aktuellen Verzeichnisworkflow verwenden auswählen, analysiert der azd init Befehl Ihr Projekt und generiert code automatisch basierend auf dem, was es ermittelt. In den folgenden Abschnitten werden die Details dazu erläutert, wie dieser Prozess funktioniert und welche Technologien derzeit unterstützt werden.

Erkennung

Der azd init Befehl erkennt Projektdateien für unterstützte Sprachen, die sich in Ihrem Projektverzeichnis und unterverzeichnissen befinden. azd überprüft außerdem Paketabhängigkeiten, um Informationen zu den von Ihrer App verwendeten Webframeworks oder Datenbanken zu sammeln. Bei Bedarf können Sie die erkannten Komponenten wie in der Bestätigungszusammenfassungsaufforderung dargestellt manuell hinzufügen oder bearbeiten.

Die aktuelle Erkennungslogik lautet wie folgt:

• Unterstützte Sprachen:
  • Python
  • JavaScript/TypeScript
  • .NET
  • Java
• Unterstützte Datenbanken:
  • MongoDB
  • PostgreSQL
• Für Python und JavaScript/TypeScript werden Webframeworks und Datenbanken automatisch erkannt.
• Wenn ein JavaScript/TypeScript-Projekt ein Front-End-Webframework (oder clientseitiges) Webframework verwendet, wird es als Front-End-Dienst klassifiziert. Wenn Ihr Dienst ein Front-End-Webframework verwendet, das derzeit nicht erkannt wird, können Sie JQuery auswählen, um gleichwertige Front-End-Dienstklassifizierung und -verhalten bereitzustellen.

Generation

Nachdem Sie die erkannten Komponenten bestätigt haben, werden die Infrastruktur-as-Code-Dateien generiert, azd init die für die Bereitstellung Ihrer Anwendung in Azure erforderlich sind.

Die Generierungslogik lautet wie folgt:

• Unterstützte Hosts:
  • Azure Container Apps.
• Für Datenbanken wird die unterstützte Zuordnung zwischen Datenbanktechnologie und Dienst verwendet:
  • MongoDB: Azure CosmosDB-API für MongoDB
  • PostgreSQL: Azure Database for PostgreSQL flexible Server
  • Redis: Azure Container Apps Redis-Add-On
• Dienste, die Datenbanken verwenden, verfügen über Umgebungsvariablen, die standardmäßig eine Verbindung mit der datenbank bereitstellen, die vorkonfiguriert ist.
• Wenn sowohl Front-End- als auch Back-End-Dienste erkannt werden, wird die CORS-Konfiguration auf dem Azure-Host für Back-End-Dienste aktualisiert, um die Standardhosting-Funktion zu ermöglichen Standard von Front-End-Diensten. Dies kann bei Bedarf in der Infrastruktur als Codekonfigurationsdateien geändert oder entfernt werden.

Hinzufügen von Unterstützung für Entwicklercontainer

Sie können Ihre Vorlage auch mit Entwicklungscontainern und Codespaces kompatibel machen. Mit einem Entwicklercontainer können Sie einen Container als umfassende Entwicklungsumgebung verwenden. Es kann verwendet werden, um eine Anwendung auszuführen, tools, Bibliotheken oder Laufzeiten zu trennen, die für die Arbeit mit einer Codebasis erforderlich sind, und um die kontinuierliche Integration und Tests zu unterstützen. Dev-Container können lokal oder remote in einer privaten oder öffentlichen Cloud ausgeführt werden. (Quelle: https://containers.dev/)

So fügen Sie Unterstützung für Entwicklercontainer hinzu:

1. Erstellen Sie einen DEVCONTAINER-Ordner im Stammverzeichnis Ihres Projekts.

2. Erstellen Sie eine devcontainer.json Datei innerhalb des .devcontainer Ordners mit den gewünschten Konfigurationen. Die azd Startvorlage enthält eine Beispieldatei devcontainer.json , die Sie nach Bedarf in Ihr Projekt kopieren und ändern können.

Weitere Informationen zum Arbeiten mit Entwicklercontainern finden Sie in der Visual Studio Code-Dokumentation.

Hinzufügen von Unterstützung für eine CI/CD-Pipeline

Sie können ihrer Vorlage auch Unterstützung für CI/CD hinzufügen, indem Sie GitHub-Aktionen oder Azure DevOps verwenden, indem Sie die folgenden Schritte ausführen:

1. Fügen Sie einen .github Ordner für GitHub-Aktionen oder einen .ado Ordner für Azure DevOps zum Stammverzeichnis Ihres Projekts hinzu.

2. Fügen Sie dem neuen Ordner eine Workflowdatei hinzu. Die azd Startvorlage enthält eine Workflowdatei für GitHub-Aktionen und Beispieldateien für Azure DevOps Pipelines für jede Plattform, die Sie nach Bedarf in Ihr Projekt kopieren und ändern können.

3. Möglicherweise müssen Sie die main.parameters.json Datei auch in Ihrem infra Ordner mit den erforderlichen Umgebungsvariablen aktualisieren, damit Der Workflow ausgeführt werden kann.

Verwenden einer Vorlage

Mit dem Workflow "Vorlage auswählen" können Sie eine vorhandene azd Vorlage auswählen, die als Ausgangspunkt verwendet werden soll. Der Inhalt der ausgewählten Vorlage wird dem Stammverzeichnis Ihres Projekts hinzugefügt. Die meisten Vorlagen stellen den erforderlichen Satz von azd Dateien und Ordnern bereit, und einige Vorlagen umfassen vollständige Infrastruktur-as-Code-Dateien, um Azure-Ressourcen für einen ausgewählten Anwendungsstapel bereitzustellen.

In diesem Beispiel verwenden Sie die Vorlage "Starter - Bicep ", die die grundlegende Struktur einer azd Vorlage und einige nützliche Codebausteine enthält, um zu beginnen.

1. Um zusammen mit den schritten vor der Verwendung einer vorhandenen Beispielanwendung zu folgen, klonen Sie das folgende Startprojekt in ein leeres Verzeichnis auf Ihrem Computer:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. Navigieren Sie in Ihrem Befehlszeilentool zu dem Stammverzeichnis des geklonten Projekts.

3. Führen Sie den azd init Befehl aus, um eine azd Vorlage zu initialisieren.

   azd init
   

4. Wenn Sie dazu aufgefordert werden, wählen Sie die Option zum Auswählen einer Vorlage aus.

5. Wählen Sie in der Liste der Vorlagen "Starter - Bicep" aus. Möglicherweise müssen Sie mithilfe der Tastaturpfeiltasten durch die Liste scrollen, um die Vorlage zu finden.

6. Wenn Sie dazu aufgefordert werden, geben Sie einen kurzen Umgebungsnamen ein, z . B. "testenv".

7. Nachdem Sie ausgeführt azd inithaben, werden dem Projekt die folgenden Ressourcen hinzugefügt:

   ├── .azdo                                        [ Configures an Azure Pipeline ]
   ├── .devcontainer                                [ For DevContainer ]
   ├── .github                                      [ Configures a GitHub workflow ]
   ├── .vscode                                      [ VS Code workspace configurations ]
   ├── .azure                                       [ Stores Azure configurations and environment variables ]
   ├── infra                                        [ Contains infrastructure as code files ]
   │   ├── main.bicep/main.tf                       [ Main infrastructure file ]
   │   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
   │   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
   └── azure.yaml                                   [ Describes the app and type of Azure resources]
   

Aktualisieren der Bicep-Dateien

Ihr Projekt enthält jetzt die Kernstruktur und Ressourcen einer azd Vorlage. Um jedoch die Azure-Ressourcen für Ihr spezifisches Projekt bereitzustellen, müssen die Bicep-Dateien im infra Ordner aktualisiert werden. Zum Hosten der Beispielanwendung benötigen Sie die folgenden Ressourcen:

• Ein Azure-App Serviceplan
• Ein auf Linux ausgeführter Azure-App-Dienst

1. Öffnen Sie das Projektverzeichnis der obersten Ebene in Ihrem Editor, z. B. Visual Studio Code.

2. Öffnen Sie die main.bicep Datei in Ihrem Editor. Diese Datei enthält nützliche Codebausteine zum Einrichten wesentlicher Variablen, Parameter und Benennungskonventionen. Fügen Sie unterhalb des Kommentarblocks um Zeile 50, die gelesen wird Add resources to be provisioned below, die folgende Bicep hinzu:

   // Creates an app service instance to host the app
   module web './core/host/appservice.bicep' = {
     name: 'web'
     scope: rg
     params: {
       name: '${abbrs.webSitesAppService}web-${resourceToken}'
       location: location
       tags: union(tags, { 'azd-service-name': 'web' })
       appServicePlanId: appServicePlan.outputs.id
       runtimeName: 'python'
       runtimeVersion: '3.8'
       scmDoBuildDuringDeployment: true
     }
   }
   
   // Create an App Service Plan to group applications under the same payment plan and SKU
   module appServicePlan './core/host/appserviceplan.bicep' = {
     name: 'appserviceplan'
     scope: rg
     params: {
       name: '${abbrs.webServerFarms}${resourceToken}'
       location: location
       tags: tags
       sku: {
         name: 'B1'
       }
     }
   }
   

   Hinweis

   • Eine eindeutige Zeichenfolge wird basierend auf der Abonnement-ID generiert und als ${resourceToken} Variable verwendet. Dieses Token wird an den Namen aller azure-Ressourcen angefügt, die von azd erstellt wurden. azd verwendet Tags zum Identifizieren von Ressourcen, damit Sie die Namen basierend auf der Benennungskonvention Ihrer Organisation ändern können.
   • Das 'azd-service-name': 'web' Tag im App-Dienst ist der Wert azd , der zum Identifizieren des Bereitstellungshosts verwendet wird. Der Wert muss mit dem übereinstimmen, was für den Dienst in der Datei "azure.yaml " definiert ist.

Aktualisieren der Datei „azure.yaml“

Um die App bereitzustellen, azd müssen Sie mehr über Ihre App wissen. Die azure.yaml Datei wird verwendet, um den Quellcodespeicherort, die Sprache und den Azure-Hostingdienst für jeden Dienst in Ihrer App zu definieren. Ausführliche Informationen finden Sie im Azure.yaml-Schema.

1. Öffnen Sie den azure.yaml Stamm des Projekts.

2. Fügen Sie die folgenden Zeilen am Ende der Datei hinzu:

   name: msdocs-python-flask-webapp-quickstart
   services:
     web:
       project: .
       language: py
       host: appservice
   

Bereitstellen der Vorlage

1. Speichern Sie alle Ihre Änderungen, und führen Sie den folgenden Befehl aus, um die App-Ressourcen in Azure bereitzustellen und bereitzustellen:

   azd up
   

2. Wenn der Befehl abgeschlossen ist, klicken Sie auf den Link in der Befehlsausgabe, um zur bereitgestellten Website zu navigieren.

Ihr Projekt ist jetzt mit der Azure Developer CLI kompatibel und kann als Vorlage verwendet werden!

Hinweis

azd unterstützt auch die Verwendung von Buildpack zum Standardmäßigen Containern Ihrer Apps. Wenn Ihre azd Vorlage auf Azure Container Apps oder Azure Kubernetes Service ausgerichtet ist, aber keine Docker-Datei enthält, azd generiert automatisch ein Image mit Buildpack.

Konfigurieren der CI/CD-Pipeline

Wenn Ihre Vorlage Unterstützung für GitHub-Aktionen oder Azure-Pipelines enthält, können Sie eine CI/CD-Pipeline mit den folgenden Schritten konfigurieren:

1. Führen Sie den folgenden Befehl aus, um Updates an das Repository zu übertragen. Der GitHub Actions-Workflow wird aufgrund des Updates ausgelöst.

   azd pipeline config    
   

2. Wechseln Sie mit Ihrem Browser zum GitHub-Repository für Ihr Projekt.

3. Wählen Sie "Aktionen" aus, um den ausgeführten Workflow anzuzeigen.

Bereinigen von Ressourcen

Wenn Sie die in diesem Artikel erstellten Ressourcen nicht mehr benötigen, führen Sie den folgenden Befehl aus:

azd down

Siehe auch

• Erstellen Sie Bicep-Dateien mit Visual Studio Code für eine Einführung in die Arbeit mit Bicep-Dateien.
• Bicep-Beispiele
• So dekompilieren Sie Azure Resource Manager-Vorlagen (ARM-Vorlagen) auf Bicep
• Azure Developer CLI-Schema "azure.yaml"

Hilfe anfordern

Informationen zum Ablegen eines Fehlers, Anfordern von Hilfe oder Vorschlagen eines neuen Features für die Azure Developer CLI finden Sie auf der Seite "Problembehandlung und Support ".

Nächste Schritte

Häufig gestellte Fragen zur Azure Developer CLI