Azure 開發人員 CLI 樣本概觀
Azure 開發人員 CLI (azd
) 範本是標準程式代碼存放庫,其中包含範例應用程式程式代碼,以及 azd
組態和基礎結構檔案。 azd
範本可讓您布建 Azure 資源、部署應用程式、設定 CI/CD 管線等等。 您可以建立自己的範本,或從範本存放庫開始使用現有的範本,例如 Awesome AZD。 在本文中,您將瞭解下列概念:
- 範本如何
azd
讓您布建和部署應用程式資源 - 如何
azd
建構範本 - 如何決定要使用現有的範本或建立範本
- 探索現有的
azd
入門範本
為何要使用 Azure 開發人員 CLI 範本?
針對雲端建置正確架構和設定的環境應用程式時,開發人員通常會面臨許多耗時且具有挑戰性的工作。 Teams 在這些環境中必須考慮許多不同的考慮,例如建立資源、套用設定、設定監視和記錄、建置 CI/CD 管線和其他工作。 azd
範本可減少並簡化這些責任,以協助開發人員從本機開發到 Azure 上成功部署的應用程式。
例如,假設您在經營票證管理和客戶通訊平臺的公司工作,這需要下列 Azure 資源:
- 兩個 App Service 實例和 App Service 方案可裝載前端 Web 應用程式和後端 API
- 一個 Key Vault 執行個體用來儲存安全應用程式祕密
- 一個 Cosmos DB 資料庫用來永久儲存應用程式資料
- Azure 監視器資源,例如 Application Insights 儀表板
- 一個服務匯流排用來管理可調整的傳訊
- CI/CD 管線以確保可透過自動化、可重複的程序可靠地部署變更。
您可以利用現有的架構範本來布建和部署大部分資源, azd
而不是從頭開始。 然後,開發小組可以專注於建置應用程式,並針對範本架構進行較小的調整。
Azure 開發人員 CLI 範本的運作方式
Azure 開發人員 CLI 範本的設計目的是使用 azd
和 azd up
等azd init
命令。 範本包含組態和基礎結構即程式代碼 (IaC) 檔案,這些檔案可供命令用來執行工作,例如布建 Azure 資源,並將應用程式程式代碼部署至它們。
例如,使用現有範本的一般 azd
工作流程包括以下步驟:
使用 參數執行
azd init
命令,--template
從 GitHub 複製現有的範本。azd init --template todo-nodejs-mongo
azd auth login
執行 命令來向 Azure 訂用帳戶進行驗證。azd auth login
執行
azd up
命令以佈建和部署範本資源至 Azure。azd up
命令會利用範本中的組態和基礎結構即程式代碼 (IaC) 檔案來布建 Azure 資源,並將您的應用程式部署至這些資源。azd up
在 Azure 中設定環境後,您可以本機修改應用程式功能或 Azure 資源範本,然後再次執行
azd up
以佈建變更。
瞭解 Azure 開發人員 CLI 樣本結構
所有 azd
範本都會根據 azd
慣例共用類似的檔案結構。 最低必要資產通常包含下列專案:
infra
資料夾 - 包含azd
範本的所有 Bicep 或 Terraform 基礎結構即程式碼檔案。azd
會執行這些檔案,以建立裝載應用程式所需的 Azure 資源。azure.yaml
file - 組態檔,定義專案中的一或多個服務,並將其對應至部署資料夾中定義的infra
Azure 資源。 例如,您可以定義 API 服務和 Web 前端服務,並將其對應至不同的 Azure 資源以進行部署。.azure
資料夾 - 包含重要 Azure 設定和環境變數,例如部署資源的位置或其他訂用帳戶資訊。src
folder - 包含所有可部署的應用程式原始程式碼。 有些azd
範本會src
排除資料夾,而且只提供基礎結構資產,以便您可以新增自己的應用程式程序代碼。注意
排除資料夾的
src
範本通常設計為基礎結構入門範本。
azd
範本也可以選擇性地包含下列一或多個資料夾:
.github
資料夾 - 保存 GitHub Actions 的 CI/CD 工作流程檔案,這是 azd 的預設 CI/CD 提供者。.azdo
資料夾 - 如果您决定將 Azure Pipelines 用於持續整合與持續傳遞,請在此資料夾中定義工作流程設定檔。.devcontainer
資料夾 - 可讓您為應用程式設定 開發容器 環境。
例如,常見的 azd
範本可能會符合下列資料夾結構:
從現有的範本開始,或建立您自己的範本
使用 azd
範本主要有兩種方法:
- 從現有的
azd
範本開始。- 如果您剛開始使用
azd
,或正在尋找範本來建置具有類似架構和架構的新應用程式,這是一個很好的選擇。
- 如果您剛開始使用
- 將現有的項目轉換為
azd
範本。- 當您已經有現有的應用程式,但想要讓它與
azd
功能相容時,這是一個很好的選擇。
- 當您已經有現有的應用程式,但想要讓它與
下列各節提供這兩個選項的詳細資訊。
從現有的範本開始
在 awesome-azd 樣本資源庫上提供廣泛的範本選擇azd
。 這些範本提供各種開發案例、語言架構和 Azure 服務的基礎結構和應用程式程式代碼。 如果您找到符合本機應用程式堆疊或所需架構的範本,您可以擴充範本程式碼,並將範本程式碼取代為您自己的
例如,下列 azd
範本提供常見應用程式架構和架構的起點:
範本 | 應用程式主機 | 技術堆疊 |
---|---|---|
在 Azure 上使用 C# API 和 MongoDB 的 React Web 應用程式 | Azure App Service | 適用於 NoSQL、Bicep 的 Azure Cosmos DB |
在 Azure 上使用 C# API 和 SQL 資料庫 來回應 Web 應用程式 | Azure App Service | Azure SQL 資料庫、Bicep |
在 Azure 上使用 C# API 和 SQL 資料庫 靜態 React Web 應用程式 + 函式 | Azure Static Web Apps、 Azure Functions | Azure SQL 資料庫、Bicep |
為您的應用程式建立新的 azd
範本
您也可以將現有的應用程式 azd
轉換成範本,以使用布建和部署功能來增強存放庫。 這個方法可讓您控制最多,併產生可重複使用的解決方案,以供應用程式的未來開發工作使用。 建立您自己的範本的高階步驟如下:
- 使用
azd init
初始化專案範本。 - 在資料夾中建立 Bicep 或 Terraform 基礎結構作為程式代碼檔案
infra
。 - 更新
azure.yaml
檔案以將應用程式服務與 Azure 資源繫結在一起。 - 使用
azd up
佈建和部署。
下列資源提供有關建立您自己的範本的詳細資訊:
使用 azd
範本的指導方針
請注意,您與 Azure 開發人員 CLI 搭配使用的每個範本都由其個別擁有者授權,該擁有者在範本隨附的合約中可能或可能不會Microsoft。 您必須負責判斷您選擇使用的任何範本適用的授權。
Microsoft不負責任何非Microsoft範本,也不會篩選這些範本的安全性、隱私權、相容性或效能問題。 您搭配 Azure 開發人員 CLI 使用的範本,包括Microsoft所提供的範本,不受任何Microsoft支援計劃或服務支援。 任何Microsoft提供的範本都提供 AS IS,沒有任何擔保。