Azure Developer CLI 的運作方式

已完成

Azure Developer CLI (azd) 是以開發人員易記的命令和基礎應用程式範本為基礎所建置。 azd 提供了一組命令,這些命令有助於使用標準化專案範本在 Azure 上安裝和管理您的應用程式。 這些範本包括所有必要的原始程式碼和設定資產,以便將您的應用程式部署至 Azure。 您可以藉由處理其中一個現有且可延伸的範例範本,或自行建置來開始使用 azd

探索 azd 命令

Azure Developer CLI 包括一組平易近人的命令,其對應至常用的開發工作流程階段,例如佈建和部署資源。 一些 azd 命令 (如 azd up) 還一次性處理多個階段,以進一步簡化這些工作。

例如,使用現有範本的一般 azd 工作流程包括以下步驟:

  1. 執行具有 --template 參數的 azd init 命令以複製現有範本,並在出現提示時設定環境名稱。

    azd init --template todo-nodejs-mongo
    
  2. 執行 azd auth login 命令以登入您的 Azure 訂用帳戶。

    azd auth login
    
  3. 執行 azd up 命令以佈建和部署範本資源至 Azure。

    azd up
    
  4. 在 Azure 中設定環境後,您可以本機修改應用程式功能或 Azure 資源範本,然後再次執行 azd up 以佈建變更。

其他 azd 命令可用於完成其他工作並展開此工作流程。 azd 已設計為具有最少數量的命令搭配少量參數,以便於使用。 一些最常用的 azd 命令包括:

  • azd init - 初始化新應用程式。
  • azd up - 使用單一命令佈建 Azure 資源並部署您的專案。
  • azd provision - 為應用程式佈建 Azure 資源。
  • azd deploy - 將應用程式程式碼部署至 Azure。
  • azd pipeline - (搶鮮版 (Beta)) 管理和設定部署管線。
  • azd auth - 使用 Azure 進行驗證。
  • azd config - 管理 azd 設定 (例如預設 Azure 訂用帳戶、位置)。
  • azd down - 删除應用程式的 Azure 資源。

探索 azd 範本

Azure Developer CLI 命令旨在使用標準化專案範本。 每個範本都是遵守特定檔案和資料夾慣例的程式碼存放庫。 範本包含為佈建 Azure 資源和部署應用程式原始程式碼 azd 所需的資產。 假設您正在新增自己的原始程式碼,有些範本可能不包括應用程式原始程式碼。 當您執行諸如 azd up 之類的命令時,工具會使用專案範本資產來執行各種工作流程步驟,例如向 Azure 佈建或部署資源。

使用 azd 範本主要有兩種方法:

  • 擴充現有 azd 範本 - 已經存在大型 azd 範本庫,涵蓋常用本機應用程式堆疊、情節和結構。 您可以在 awesome-azd 範本程式庫 網站上瀏覽許多範本。 如果您找到對應至本機應用程式堆疊或所需架構的範本,您可以使用它作為起點。 然後,取代原始程式碼目錄,並修改設定或基礎結構檔案,以符合您的需求。

  • 將您自己的應用程式轉換為 azd 範本 - 您也可以遵循「使您的專案與 azd 相容」指南將現有應用程式轉換為 azd template。 最初建立自己的範本通常需要更多的工作,但允許進行最大的控制,並為應用程式的未來開發工作提供可重複使用的解決方案。 建立自己的範本之核心步驟如下:

    • 使用 azd init 初始化專案範本。

    • 使用 Bicep 或 Terraform 將基礎結構建立為程式碼檔案。

    • 更新 azure.yaml 檔案以將應用程式服務與 Azure 資源繫結在一起。

    • 使用 azd up 佈建和部署。

      A diagram showing the Azure Developer CLI template creation workflow.

無論您選擇哪種方法,產成的範本結構都相同。 所有 azd 範本都包括以下資產:

  • infra 資料夾 - 包含 azd 範本的所有 Bicep 或 Terraform 基礎結構即程式碼檔案。 基礎結構即程式碼可讓您在宣告式定義檔案中定義基礎結構資源和設定,以在每次部署時可靠地產生相同的環境。 Terraform 可以在多個雲端平台上運作,而 Bicep 特定於是 Azure。 azd 會執行這些檔案,以建立裝載應用程式所需的 Azure 資源。 您可以在「什麼是基礎結構即程式碼?」訓練模組中深入了解基礎結構即程式碼。

  • azure.yaml 檔案 - 設定檔,用於定義專案中的一個或多個服務,並將其對應至 Azure 資源以進行部署。 例如,您可以定義 API 服務和 Web 前端服務,每個服務都具有將其對應至不同 Azure 資源以進行部署的屬性。

  • .azure 資料夾 - 包含重要 Azure 設定和環境變數,例如部署資源的位置或其他訂用帳戶資訊。

  • src folder - 包含所有可部署的應用程式原始程式碼。 有些 azd 範本只提供基礎結構資產,src 目錄為空,供您新增自己的應用程式程式碼。

    A screenshot showing the Azure Developer CLI template structure.

大多數 azd 範本還可以選擇性包括以下一個或多個資料夾:

  • .devcontainer 資料夾 - 允許您為應用程式設定開發容器環境。 常用開發環境方法,並非特定於 azd
  • .github 資料夾 - 保留 GitHub Actions 的 CI/CD 工作流程檔案,即 azd 的預設 CI/CD 提供者。
  • .azdo 資料夾 - 如果您决定將 Azure Pipelines 用於持續整合與持續傳遞,請在此資料夾中定義工作流程設定檔。