Azure 部署環境的 Azure 開發人員 CLI 支援

發行項
12/13/2023

Azure 開發人員 CLI （azd）支援 Azure 部署環境。 Azure 部署環境（ADE）是預先設定的 Azure 資源集合，部署在預先定義的訂用帳戶中。 Azure 治理會根據環境類型套用至這些訂用帳戶，例如沙箱、測試、預備或生產環境。使用 Azure 部署環境，您可以強制執行企業安全性原則，並提供一組精心策劃的預先定義基礎結構即程式碼（IaC）範本。

必要條件

確認您已完成下列必要條件，以使用 azd 搭配 Azure 部署環境使用：

在本機安裝 azd 或可透過 Cloud Shell 存取 azd
使用開發人員中心、專案和範本目錄建立和設定 Azure 部署環境
在開發人員中心層級和專案層級設定的環境類型
確定開發人員在專案上具有部署環境使用者角色

提示

瞭解 Azure 部署環境的重要概念，對於透過 azd 加以使用至關重要。

啟用 Azure 部署環境支援

您可以使用 azd 或 azd provision 等 azd up 標準命令，設定將資源布建和部署至部署環境。若要啟用 Azure 部署環境的支援，請執行下列命令：

azd config set platform.type devcenter

當設定為 devcenter 時 platform.type ，所有 azd 遠端環境狀態和布建都會利用新的開發人員中心元件。此設定也表示 infra 會有效地忽略本機範本中的資料夾。相反地， azd 將會使用您開發人員中心目錄中定義的其中一個基礎結構範本來布建資源。

您也可以透過下列命令停用開發人員中心支援：

azd config unset platform

使用 Azure 部署環境

啟用開發人員中心功能時，一些常見 azd 命令的預設行為會變更以使用這些遠端環境。開發人員中心功能會擴充標準 azd 遠端環境支援所提供的功能。

azd init

開發人員 azd init 中心模式中的命令體驗會顯示所有 azd 相容的 ADE 範本，以便從您設定的目錄進行選取。在 init 程式中，在複製範本程式碼之後 azd ， azure.yaml 檔案會自動更新，以 platform 根據所選範本包含具有所選組態的區段。組態包含開發人員中心名稱、目錄和環境定義。

`azd init`

azd up

此命令 azd up 會將您的應用程式封裝、布建及部署至 Azure 部署環境。不過，命令的 azd up 布建階段將會在遠端開發人員中心使用策劃的基礎結構即程式碼範本，而部署階段會在範本 azd 中部署原始程式碼。啟用開發人員中心模式時，將會忽略 infra 本機 azd 範本中的資料夾， azd 並且只使用開發人員中心範本布建資源。此命令也會提示您輸入任何必要值，例如 Azure 部署環境專案或環境類型。

azd up

azd template list

azd template list此命令會在開發人員中心目錄中顯示可用的基礎結構範本，而不是顯示預設 AZD Awesome 資源庫中的範本。目錄提供一組經過策劃和核准的基礎結構即程式碼範本，可供開發小組用來建立環境。

azd template list

A screenshot showing the updated template gallery.

azd provision

此命令 azd provision 會建立新的開發人員中心環境。此命令會提示您輸入任何遺漏的值，例如環境類型或專案。當命令執行時，它會使用相關聯的基礎結構範本，為該環境布建正確的 Azure 資源集合。啟用開發人員中心模式時，將會忽略 infra 本機 azd 範本中的資料夾， azd 並且只使用開發人員中心範本布建資源。

azd provision

azd env list

azd env list此命令會顯示您在開發人員入口網站中看到的相同環境清單。

azd env list

標記 Azure 部署環境的資源

azd Azure 部署環境的布建仰賴來自開發人員中心目錄的策劃範本。目錄中的範本不一定會將標籤指派給布建的 Azure 資源，讓您將應用程式服務與檔案 azure.yaml 中的關聯。如果範本未指派標籤，您可以透過下列兩種方式之一解決此問題：

請與您的開發人員中心目錄管理員合作，以確保布建的 Azure 資源包含標籤，以將它們與檔案 azure.yaml 中定義的服務產生關聯。

resoureName在 azure.yaml 檔案中指定，而不是使用標記：

services:
    api:
        project: ./src/api
        host: containerapp
        language: js
        resourceName: sample-api-containerapp
    web:
        project: ./src/web
        host: containerapp
        language: js
        resourceName: sample-web-containerapp

設定開發人員中心設定

您可以在多個位置定義 azd 開發人員中心的設定。設定會從這些位置結合，以下列優先順序建立最後一組組態：

環境變數
Azd 環境設定
專案組態
使用者設定

azd 會自動提示您輸入這些來源中遺漏的任何組態值。下列各節會詳細說明這些組態選項。

環境變數

將會探索及使用 azd 下列環境變數：

AZURE_DEVCENTER_NAME
AZURE_DEVCENTER_PROJECT
AZURE_DEVCENTER_CATALOG
AZURE_DEVCENTER_ENVIRONMENT_DEFINITION
AZURE_DEVCENTER_ENVIRONMENT_TYPE
AZURE_DEVCENTER_ENVIRONMENT_USER

定義組態

在檔案中的 .azure/<env>/config.json 環境範圍定義 azd 開發人員中心的組態：

{
    "platform": {
        "config": {
            "catalog": "SampleCatalog",
            "environmentDefinition": "Todo",
            "environmentType": "Dev",
            "name": "sample-devcenter",
            "Project": "SampleProject"
        }
    }
}

專案範圍

在檔案節點 azure.yaml 的專案 azd 範圍 platform 定義開發人員中心的組態：

name: todo-nodejs-mongo-aca
metadata:
    template: todo-nodejs-mongo-aca@0.0.1-beta
platform:
    type: devcenter
    config:
        catalog: SampleCatalog
        environmentDefinition: Todo
        name: sample-devcenter
        project: SampleProject
services:
    api:
        project: ./src/api
        host: containerapp
        language: js
    web:
        project: ./src/web
        host: containerapp
        language: js

使用者範圍

在檔案中的 ~/<user_profile>/.azd/config.json 使用者範圍定義開發人員中心的組態：

{
    "platform": {
        "config": {
            "catalog": "SampleCatalog",
            "environmentDefinition": "Todo",
            "environmentType": "Dev",
            "name": "sample-devcenter",
            "Project": "SampleProject"
        }
    }
}

共用方式為