Delen via

Overzicht van Azure Developer CLI-sjablonen

  • Artikel

Azure Developer CLI-sjablonen (azd) zijn standaardcodeopslagplaatsen met voorbeeldtoepassingscode, evenals azd configuratie- en infrastructuurbestanden. azd met sjablonen kunt u Azure-resources inrichten, uw toepassing implementeren, CI/CD-pijplijnen configureren en meer. U kunt uw eigen sjablonen maken of aan de slag gaan met een bestaande sjabloon vanuit een sjabloonopslagplaats, zoals Awesome AZD. In dit artikel leert u meer over de volgende concepten:

  • Hoe azd u met sjablonen app-resources kunt inrichten en implementeren
  • Hoe azd sjablonen zijn gestructureerd
  • Bepalen of u een bestaande sjabloon wilt gebruiken of een sjabloon wilt maken
  • Bestaande azd starterssjablonen verkennen

Waarom azure Developer CLI-sjablonen gebruiken?

Ontwikkelaars hebben vaak te maken met veel tijdrovende en uitdagende taken bij het bouwen van goed ontworpen en geconfigureerde omgevings-apps voor de cloud. Teams moeten rekening houden met veel verschillende problemen in deze omgevingen, zoals het maken van resources, het toepassen van configuraties, het instellen van bewaking en logboekregistratie, het bouwen van CI/CD-pijplijnen en andere taken. azd sjablonen verminderen en stroomlijnen deze verantwoordelijkheden om de ontwikkelaar te helpen bij hun traject van lokale ontwikkeling naar een geïmplementeerde app in Azure.

Stel dat u werkt bij een bedrijf dat een ticketbeheer- en klantcommunicatieplatform beheert, waarvoor de volgende Azure-resources zijn vereist:

  • Twee App Service-exemplaren en een App Service-plan voor het hosten van een front-end-web-app en back-end-API
  • Een Key Vault-exemplaar voor het opslaan van beveiligde app-geheimen
  • Een Cosmos DB-database voor het permanent opslaan van app-gegevens
  • Azure Monitor-resources, zoals Application Insights-dashboards
  • Een Service Bus voor het beheren van schaalbare berichten
  • CI/CD-pijplijnen om ervoor te zorgen dat wijzigingen betrouwbaar kunnen worden geïmplementeerd via een geautomatiseerd, herhaalbaar proces.

In plaats van vanaf de basis te beginnen, kunt u bestaande azd architectuursjablonen gebruiken om de meeste resources voor u in te richten en te implementeren. Het ontwikkelteam kan zich vervolgens richten op het bouwen van de app en het aanbrengen van kleinere aanpassingen aan de sjabloonarchitectuur.

Hoe Azure Developer CLI-sjablonen werken

Azure Developer CLI-sjablonen zijn ontworpen voor gebruik met azd opdrachten zoals azd init en azd up. De sjablonen bevatten configuratie- en infrastructuur als codebestanden (IaC) die door de opdrachten worden gebruikt om taken uit te voeren, zoals het inrichten van Azure-resources en het implementeren van de app-code.

Een typische azd werkstroom met behulp van een bestaande sjabloon bevat bijvoorbeeld de volgende stappen:

  1. Voer de azd init opdracht uit met de --template parameter om een bestaande sjabloon te klonen vanuit GitHub.

    azd init --template todo-nodejs-mongo

  2. Voer de azd auth login opdracht uit om te verifiëren bij uw Azure-abonnement.

    azd auth login

  3. Voer de azd up opdracht uit om de sjabloonbronnen in te richten en te implementeren in Azure. De azd up opdracht maakt gebruik van de IaC-bestanden (configuration and infrastructure-as-code) in uw sjabloon om Azure-resources in te richten en uw toepassing in die resources te implementeren.

    azd up

  4. Zodra uw omgeving is ingesteld in Azure, kunt u de toepassingsfuncties of Azure-resourcesjablonen lokaal wijzigen en vervolgens opnieuw uitvoeren azd up om uw wijzigingen in te richten.

Inzicht in azure Developer CLI-sjabloonstructuur

Alle azd sjablonen delen een vergelijkbare bestandsstructuur op azd basis van conventies. De minimaal vereiste activa omvatten over het algemeen het volgende:

  • infra map : bevat alle Bicep- of Terraform-infrastructuur als codebestanden voor de azd sjabloon. azd voert deze bestanden uit om de Azure-resources te maken die nodig zijn om uw app te hosten.

  • azure.yaml bestand : een configuratiebestand dat een of meer services in uw project definieert en deze toe wijst aan Azure-resources die zijn gedefinieerd in de infra map voor implementatie. U kunt bijvoorbeeld een API-service en een webfront-endservice definiëren en deze toewijzen aan verschillende Azure-resources voor implementatie.

  • .azure map : bevat essentiële Azure-configuraties en omgevingsvariabelen, zoals de locatie voor het implementeren van resources of andere abonnementsgegevens.

  • src map : bevat alle broncode van de implementeerbare app. Sommige azd sjablonen sluiten de src map uit en bieden alleen infrastructuurassets, zodat u uw eigen toepassingscode kunt toevoegen.

    Notitie

    Sjablonen die de map uitsluiten, zijn over het src algemeen ontworpen als startersjablonen voor infrastructuur.

azd sjablonen bevatten desgewenst ook een of meer van de volgende mappen:

  • .github map : bevat de CI/CD-werkstroombestanden voor GitHub Actions, de standaard CI/CD-provider voor azd.
  • .azdo map : als u besluit Azure Pipelines te gebruiken voor CI/CD, definieert u de configuratiebestanden van de werkstroom in deze map.
  • .devcontainer map : hiermee kunt u een Dev Container-omgeving instellen voor uw toepassing.

Een algemene azd sjabloon kan bijvoorbeeld overeenkomen met de volgende mapstructuur:

Een schermopname van een Azure Developer CLI-sjabloonstructuur.

Begin met een bestaande sjabloon of maak uw eigen sjabloon

Er zijn twee hoofdmethoden voor het werken met azd sjablonen:

  • Begin met een bestaande azd sjabloon.
    • Dit is een goede keuze als u net aan de slag gaat of azd als u op zoek bent naar een sjabloon om uit te bouwen voor een nieuwe app met een vergelijkbare architectuur en frameworks.
  • Een bestaand project converteren naar een azd sjabloon.
    • Dit is een goede keuze wanneer u al een bestaande app hebt, maar u deze compatibel wilt maken met azd mogelijkheden.

De volgende secties bevatten meer informatie over deze twee opties.

Beginnen met een bestaande sjabloon

Er is een brede selectie sjablonen azd beschikbaar in de awesome-azd-sjabloongalerie . Deze sjablonen bieden infrastructuur- en toepassingscode voor verschillende ontwikkelingsscenario's, taalframeworks en Azure-services. Als u een sjabloon vindt die overeenkomt met uw lokale toepassingsstack of gewenste architectuur, kunt u de sjablooncode uitbreiden en vervangen door uw eigen sjablooncode

De volgende azd sjablonen bieden bijvoorbeeld uitgangspunten voor algemene app-architecturen en frameworks:

Template App-host Tech stack
React Web App met C#-API en MongoDB in Azure Azure App Service Azure Cosmos DB for NoSQL, Bicep
React Web App met C#-API en SQL Database in Azure Azure App Service Azure SQL Database, Bicep
Static React Web App + Functions met C#-API en SQL Database in Azure Azure Static Web Apps, Azure Functions Azure SQL Database, Bicep

Een nieuwe azd sjabloon voor uw app maken

U kunt een bestaande app ook converteren naar een azd sjabloon om de opslagplaats te verbeteren met inrichtings- en implementatiemogelijkheden. Met deze aanpak kunt u de meeste controle en produceert u een herbruikbare oplossing voor toekomstige ontwikkelingswerkzaamheden in de app. De stappen op hoog niveau voor het maken van uw eigen sjabloon zijn als volgt:

  • Initialiseer de projectsjabloon met azd init.
  • Maak de Bicep- of Terraform-infrastructuur als codebestanden in de infra map.
  • Werk het azure.yaml bestand bij om de app-services te koppelen aan de Azure-resources.
  • Inrichten en implementeren met azd up.

De volgende bronnen bieden meer informatie over het maken van uw eigen sjablonen:

Richtlijnen voor het gebruik van azd sjablonen

Houd er rekening mee dat elke sjabloon die u met Azure Developer CLI gebruikt, wordt gelicentieerd door de desbetreffende eigenaar (die al dan niet Microsoft is) onder de overeenkomst die bij de sjabloon hoort. Het is uw verantwoordelijkheid om te bepalen welke licentie van toepassing is op elke sjabloon die u wilt gebruiken.

Microsoft is niet verantwoordelijk voor niet-Microsoft-sjablonen en schermt deze sjablonen niet op beveiligings-, privacy-, compatibiliteits- of prestatieproblemen. De sjablonen die u gebruikt met Azure Developer CLI, inclusief sjablonen van Microsoft, worden niet ondersteund door een Microsoft-ondersteuningsprogramma of -service. Alle door Microsoft geleverde sjablonen worden geleverd ALS IS zonder enige garantie van welke aard dan ook.

Volgende stappen

Een sjabloon selecteren en implementeren