Dela via

Översikt över CLI-mallar för Azure Developer

  • Artikel

Azure Developer CLI-mallar (azd) är standardkodlagringsplatser som innehåller exempelprogramkod, samt azd konfigurations- och infrastrukturfiler. azd med mallar kan du etablera Azure-resurser, distribuera ditt program, konfigurera CI/CD-pipelines med mera. Du kan antingen skapa egna mallar eller komma igång med en befintlig mall från en malllagringsplats, till exempel Awesome AZD. I den här artikeln får du lära dig mer om följande begrepp:

  • Så azd här gör mallar att du kan etablera och distribuera appresurser
  • Hur azd mallar är strukturerade
  • Så här bestämmer du om du vill använda en befintlig mall eller skapa en
  • Utforska befintliga azd startmallar

Varför ska du använda CLI-mallar för Azure Developer?

Utvecklare står ofta inför många tidskrävande och utmanande uppgifter när de skapar korrekt strukturerade och konfigurerade miljöappar för molnet. Teams måste ta hänsyn till många olika problem i dessa miljöer, till exempel att skapa resurser, tillämpa konfigurationer, konfigurera övervakning och loggning, skapa CI/CD-pipelines och andra uppgifter. azd mallar minskar och effektiviserar dessa ansvarsområden för att hjälpa utvecklaren att ta sig från lokal utveckling till en app som distribuerats korrekt i Azure.

Anta till exempel att du arbetar på ett företag som driver en plattform för biljetthantering och kundkommunikation, vilket kräver följande Azure-resurser:

  • Två App Service-instanser och en App Service-plan för att vara värd för en klientwebbapp och serverdels-API
  • En Key Vault-instans för att lagra säkra apphemligheter
  • En Cosmos DB-databas för permanent lagring av appdata
  • Azure Monitor-resurser som Application Insights-instrumentpaneler
  • En Service Bus för att hantera skalbara meddelanden
  • CI/CD-pipelines för att säkerställa att ändringar kan distribueras på ett tillförlitligt sätt via en automatiserad, repeterbar process.

I stället för att börja från grunden kan du använda azd befintliga arkitekturmallar för att etablera och distribuera de flesta resurserna åt dig. Utvecklingsteamet kan sedan fokusera på att skapa appen och göra mindre justeringar i mallarkitekturen.

Så här fungerar AZURE Developer CLI-mallar

Azure Developer CLI-mallar är utformade för att fungera med azd kommandon som azd init och azd up. Mallarna innehåller IaC-filer (configuration and infrastructure-as-code) som används av kommandona för att utföra uppgifter som att etablera Azure-resurser och distribuera appkoden till dem.

Ett vanligt azd arbetsflöde med hjälp av en befintlig mall innehåller till exempel följande steg:

  1. azd init Kör kommandot med parametern --template för att klona en befintlig mall från GitHub.

    azd init --template todo-nodejs-mongo

  2. Kör kommandot för att autentisera azd auth login till din Azure-prenumeration.

    azd auth login

  3. azd up Kör kommandot för att etablera och distribuera mallresurserna till Azure. Kommandot azd up använder IaC-filerna (konfiguration och infrastruktur som kod) i mallen för att etablera Azure-resurser och distribuera programmet till dessa resurser.

    azd up

  4. När din miljö har konfigurerats i Azure kan du lokalt ändra programfunktionerna eller Azure-resursmallarna och sedan köra azd up igen för att etablera dina ändringar.

Förstå CLI-mallstrukturen för Azure Developer

Alla azd mallar delar en liknande filstruktur baserat på azd konventioner. De minsta nödvändiga tillgångarna omfattar vanligtvis följande:

  • infra folder – Innehåller hela Bicep- eller Terraform-infrastrukturen som kodfiler för mallen azd . azd kör dessa filer för att skapa de Azure-resurser som krävs för att vara värd för din app.

  • azure.yaml file – En konfigurationsfil som definierar en eller flera tjänster i projektet och mappar dem till Azure-resurser som definierats i infra mappen för distribution. Du kan till exempel definiera en API-tjänst och en webbklientdelstjänst och mappa dem till olika Azure-resurser för distribution.

  • .azure folder – Innehåller viktiga Azure-konfigurationer och miljövariabler, till exempel platsen för att distribuera resurser eller annan prenumerationsinformation.

  • src folder – Innehåller all distributionsbar app-källkod. Vissa azd mallar undantar src mappen och tillhandahåller bara infrastrukturtillgångar så att du kan lägga till din egen programkod.

    Kommentar

    Mallar som undantar src mappen är vanligtvis utformade som startmallar för infrastruktur.

azd mallar kan också innehålla en eller flera av följande mappar:

  • .github folder – Innehåller CI/CD-arbetsflödesfilerna för GitHub Actions, standard-CI/CD-providern för azd.
  • .azdo mapp – Om du bestämmer dig för att använda Azure Pipelines för CI/CD definierar du arbetsflödeskonfigurationsfilerna i den här mappen.
  • .devcontainer mapp – Gör att du kan konfigurera en Dev Container-miljö för ditt program.

En vanlig azd mall kan till exempel matcha följande mappstruktur:

En skärmbild som visar en CLI-mallstruktur för Azure Developer.

Börja med en befintlig mall eller skapa en egen

Det finns två huvudsakliga metoder för att arbeta med azd mallar:

  • Börja med en befintlig azd mall.
    • Det här är ett bra val om du precis har börjat med azd eller om du letar efter en mall att bygga ut för en ny app med en liknande arkitektur och ramverk.
  • Konvertera ett befintligt projekt till en azd mall.
    • Det här är ett bra val när du redan har en befintlig app, men du vill göra den kompatibel med azd funktioner.

Följande avsnitt innehåller mer information om dessa två alternativ.

Börja med en befintlig mall

Ett brett urval av azd mallar finns i mallgalleriet awesome-azd . Dessa mallar tillhandahåller infrastruktur och programkod för olika utvecklingsscenarier, språkramverk och Azure-tjänster. Om du hittar en mall som överensstämmer med din lokala programstacken eller önskad arkitektur kan du utöka och ersätta mallkoden med din egen

Följande mallar ger till exempel azd utgångspunkter för vanliga apparkitekturer och ramverk:

Template Appvärd Teknikstack
React Web App med C#API och MongoDB i Azure Azure App Service Azure Cosmos DB för NoSQL, Bicep
React Web App med C# API och SQL Database i Azure Azure App Service Azure SQL Database, Bicep
Static React Web App + Functions med C# API och SQL Database i Azure Azure Static Web Apps, Azure Functions Azure SQL Database, Bicep

Skapa en ny azd mall för din app

Du kan också konvertera en befintlig app till en azd mall för att förbättra lagringsplatsen med etablerings- och distributionsfunktioner. Den här metoden ger mest kontroll och skapar en återanvändbar lösning för framtida utvecklingsarbete i appen. De övergripande stegen för att skapa en egen mall är följande:

  • Initiera projektmallen med azd init.
  • Skapa Bicep- eller Terraform-infrastrukturen som kodfiler i infra mappen.
  • azure.yaml Uppdatera filen för att koppla apptjänsterna till Azure-resurserna.
  • Etablera och distribuera med azd up.

Följande resurser innehåller mer information om hur du skapar egna mallar:

Riktlinjer för att använda azd mallar

Observera att varje mall som du använder med Azure Developer CLI är licensierad av dess respektive ägare (vilket kan vara Microsoft) enligt det avtal som medföljer mallen. Det är ditt ansvar att avgöra vilken licens som gäller för alla mallar som du väljer att använda.

Microsoft ansvarar inte för några mallar som inte kommer från Microsoft och kontrollerar inte dessa mallar för säkerhets-, sekretess-, kompatibilitets- eller prestandaproblem. De mallar som du använder med Azure Developer CLI, inklusive de som tillhandahålls från Microsoft, stöds inte av något Microsoft-supportprogram eller någon tjänst. Alla Microsoft-tillhandahållna mallar tillhandahålls som de är utan garanti av något slag.

Nästa steg

Välj och distribuera en mall