Přehled šablon Azure Developer CLI

  • Článek

Šablony Azure Developer CLI (azd) jsou standardní úložiště kódu, která obsahují ukázkový kód aplikace a soubory azd konfigurace a infrastruktury. azd Šablony umožňují zřizovat prostředky Azure, nasazovat aplikaci, konfigurovat kanály CI/CD a provádět další funkce. Můžete buď vytvořit vlastní šablony, nebo začít používat existující šablonu z úložiště šablon, jako je Například Awesome AZD. V tomto článku se seznámíte s následujícími koncepty:

  • Jak azd šablony umožňují zřizovat a nasazovat prostředky aplikací
  • Jak azd jsou šablony strukturované
  • Jak se rozhodnout, jestli použít existující šablonu nebo vytvořit
  • Prozkoumání existujících azd úvodních šablon

Proč používat šablony Azure Developer CLI?

Vývojáři často čelí mnoha časově náročným a náročným úkolům při vytváření správně navržených a nakonfigurovaných aplikací prostředí pro cloud. Týmy musí v těchto prostředích počítat s mnoha různými obavami, jako jsou vytváření prostředků, používání konfigurací, nastavení monitorování a protokolování, vytváření kanálů CI/CD a dalších úloh. azd šablony snižují a zjednodušují tyto odpovědnosti, aby vývojářům pomohly na cestě od místního vývoje k úspěšně nasazené aplikaci v Azure.

Předpokládejme například, že pracujete ve společnosti, která provozuje správu lístků a komunikační platformu zákazníka, která vyžaduje následující prostředky Azure:

  • Dvě instance služby App Service a plán služby App Service pro hostování front-endové webové aplikace a back-endového rozhraní API
  • Instance služby Key Vault pro ukládání zabezpečených tajných kódů aplikací
  • Databáze Cosmos DB pro trvalé ukládání dat aplikací
  • Prostředky azure Monitoru, jako jsou řídicí panely Application Insights
  • Služba Service Bus pro správu škálovatelného zasílání zpráv
  • Kanály CI/CD, které zajišťují spolehlivé nasazení změn prostřednictvím automatizovaného opakovatelného procesu.

Místo toho, abyste začali od základů, azd můžete využít existující šablony architektury ke zřízení a nasazení většiny prostředků za vás. Vývojový tým se pak může zaměřit na vytvoření aplikace a provést menší úpravy architektury šablony.

Jak fungují šablony Azure Developer CLI

Šablony Azure Developer CLI jsou navržené tak, aby fungovaly s azd příkazy, jako azd init jsou a azd up. Šablony zahrnují soubory konfigurace a infrastruktury jako kódu (IaC), které jsou používány příkazy k provádění úloh, jako je zřizování prostředků Azure a nasazení kódu aplikace do nich.

Typický pracovní postup, který používá existující šablonu, azd například obsahuje následující kroky:

  1. Spuštěním azd init příkazu s parametrem --template naklonujte existující šablonu z GitHubu dolů.

    azd init --template todo-nodejs-mongo

  2. Spuštěním azd auth login příkazu ověřte předplatné Azure.

    azd auth login

  3. Spuštěním azd up příkazu zřiďte a nasaďte prostředky šablony do Azure. Příkaz azd up využívá soubory konfigurace a infrastruktury jako kódu (IaC) ve vaší šabloně ke zřízení prostředků Azure a nasazení aplikace do těchto prostředků.

    azd up

  4. Po nastavení prostředí v Azure můžete místně upravit funkce aplikací nebo šablony prostředků Azure a pak znovu spustit azd up , abyste zřídili změny.

Principy struktury šablon Azure Developer CLI

Všechny azd šablony sdílejí podobnou strukturu souborů na azd základě konvencí. Minimální požadované prostředky obecně zahrnují následující:

  • infra složka – Obsahuje veškerou infrastrukturu Bicep nebo Terraform jako soubory kódu pro azd šablonu. azd tyto soubory spustí, aby se vytvořily prostředky Azure potřebné k hostování vaší aplikace.

  • azure.yaml soubor – Konfigurační soubor, který definuje jednu nebo více služeb v projektu a mapuje je na prostředky Azure definované ve infra složce pro nasazení. Můžete například definovat službu API a webovou front-end službu a mapovat je na různé prostředky Azure pro nasazení.

  • .azure složka – Obsahuje základní konfigurace Azure a proměnné prostředí, například umístění pro nasazení prostředků nebo jiné informace o předplatném.

  • src složka – Obsahuje veškerý nasaditelný zdrojový kód aplikace. Některé azd šablony složku vylučují src a poskytují pouze prostředky infrastruktury, abyste mohli přidat vlastní kód aplikace.

    Poznámka:

    Šablony, které složku vylučují src , jsou obecně navrženy jako úvodní šablony infrastruktury.

azd Šablony také volitelně obsahují jednu nebo více následujících složek:

  • .github folder – Obsahuje soubory pracovního postupu CI/CD pro GitHub Actions, výchozího poskytovatele CI/CD pro azd.
  • .azdo složka – Pokud se rozhodnete používat Azure Pipelines pro CI/CD, definujte konfigurační soubory pracovního postupu v této složce.
  • .devcontainer folder – Umožňuje nastavit prostředí vývojového kontejneru pro vaši aplikaci.

Například běžná azd šablona může odpovídat následující struktuře složek:

Snímek obrazovky znázorňující strukturu šablony Azure Developer CLI

Začněte s existující šablonou nebo si vytvořte vlastní.

Práce se šablonami azd má dva hlavní přístupy:

  • Začněte s existující azd šablonou.
    • To je dobrá volba, pokud teprve začínáte azd nebo pokud hledáte šablonu pro vytvoření nové aplikace s podobnou architekturou a architekturami.
  • Převeďte existující projekt na azd šablonu.
    • To je dobrá volba, pokud už máte existující aplikaci, ale chcete ji zajistit kompatibilitu s možnostmi azd .

Následující části obsahují další informace o těchto dvou možnostech.

Začínáme s existující šablonou

Široká škála azd šablon je k dispozici v galerii šablon awesome-azd . Tyto šablony poskytují infrastrukturu a kód aplikace pro různé vývojové scénáře, jazykové architektury a služby Azure. Pokud najdete šablonu, která odpovídá místnímu zásobníku aplikací nebo požadované architektuře, můžete kód šablony rozšířit a nahradit vlastním kódem.

Například následující azd šablony poskytují výchozí body pro běžné architektury a architektury aplikací:

Šablona Hostitel aplikací Tech Stack
React Web App with C# API and MongoDB on Azure Azure App Service Azure Cosmos DB for NoSQL, Bicep
React Web App with C# API and SQL Database on Azure Azure App Service Azure SQL Database, Bicep
Static React Web App + Functions s využitím rozhraní API jazyka C# a SLUŽBY SQL Database v Azure Azure Static Web Apps, Azure Functions Azure SQL Database, Bicep

Vytvoření nové azd šablony pro aplikaci

Existující aplikaci můžete také převést na azd šablonu, která vylepšuje úložiště funkcemi zřizování a nasazení. Tento přístup umožňuje největší kontrolu a vytváří opakovaně použitelné řešení pro budoucí vývoj v aplikaci. Základní kroky pro vytvoření vlastní šablony jsou následující:

  • Inicializace šablony projektu pomocí azd init.
  • Ve složce vytvořte infrastrukturu Bicep nebo Terraform jako soubory infra kódu.
  • azure.yaml Aktualizujte soubor tak, aby svážely aplikační služby s prostředky Azure.
  • Zřiďte a nasaďte pomocí azd upnástroje .

Následující zdroje informací poskytují další informace o vytváření vlastních šablon:

Pokyny pro používání azd šablon

Upozorňujeme, že každá šablona, kterou používáte s Azure Developer CLI, má licenci příslušného vlastníka (což může nebo nemusí být Microsoft) podle smlouvy, která tuto šablonu doprovází. Je vaší zodpovědností určit, jaká licence se vztahuje na libovolnou šablonu, kterou chcete použít.

Společnost Microsoft nezodpovědí za žádné šablony, které nejsou microsofty, a nezobrazová tyto šablony kvůli problémům se zabezpečením, ochranou osobních údajů, kompatibilitou ani výkonem. Šablony, které používáte s Azure Developer CLI, včetně těch od Microsoftu, nejsou podporovány žádným programem ani službou podpory Microsoftu. Všechny šablony poskytované společností Microsoft jsou poskytovány tak, jak jsou poskytovány bez záruky jakéhokoli druhu.

Další kroky

Výběr a nasazení šablony