使用 Azure CLI 建立和存取環境

備註

請於 2027 年 2 月 22 日前將您的 Azure 部署環境工作流程轉換為 Microsoft 服務、Azure 服務或合作夥伴解決方案。 Azure 部署環境將於此日退休。

本文說明如何使用 Azure CLI 在現有的 Azure 部署環境專案中建立和存取 環境 。

先決條件

類別 Requirement
安裝 安裝適用於 Azure Deployment Environments 的 Azure CLI 擴充功能。
Procedure 完成使用 Azure CLI 建立和設定開發人員中心。
Procedure 完成 使用 Azure CLI 建立和設定專案。
權限 若要建立環境: 部署環境 使用者角色、 DevCenter 專案管理員 角色或具有適當許可權的內建角色。

建立環境

建立環境會自動建立必要的資源和儲存它們的資源群組。 資源群組名稱遵循型樣 {projectName}-{environmentName}。 您可以在 Azure 入口網站 中檢視資源群組。

要建立環境並設定資源,請在 Azure CLI 中完成以下步驟。 您可以檢視特定 Azure Resource Manager 範本 (ARM 範本) 中定義的輸出。

備註

只有具有 部署環境使用者 角色、 DevCenter 專案管理員 角色或具有適當許可權的內建角色的使用者才能建立環境。 具有 部署環境讀取者 角色的使用者可以檢視自己的環境,以及其他人建立的環境。

  1. 登入 Azure CLI:

    az login
    
  2. 安裝或升級 CLI 的 Azure 開發人員中心延伸模組:

    az extension add --name devcenter --upgrade
    
  3. 列出您有權存取的所有 Azure 部署環境專案:

    az graph query -q "Resources | where type =~ 'microsoft.devcenter/projects'" -o table
    
  4. 將預設訂用帳戶設定為包含專案的訂用帳戶:

    az account set --subscription <subscriptionName>
    
  5. 將預設資源群組設定為包含專案的資源群組:

    az config set defaults.group=<resourceGroupName>
    
  6. 列出您可以在特定專案中建立的環境型別:

    az devcenter dev environment-type list --dev-center-name <devcenterName> --project-name <projectName> -o table
    
  7. 列出特定專案可用的 環境定義 :

    az devcenter dev environment-definition list --dev-center-name <devcenterName> --project-name <projectName> -o table
    
  8. environment-definition 是一種在 environment.yaml 檔案中定義的基礎設施即程式碼範本。 透過從可用環境定義清單中使用環境定義來建立環境:

    az devcenter dev environment create --dev-center-name <devcenterName>
        --project-name <projectName> --environment-name <environmentName> --environment-type <environmentType>
        --environment-definition-name <environmentDefinitionName> --catalog-name <catalogName>
    

    如果特定的 environment-definition* 需要任何參數,請使用 --parameters 並提供 JSON 字串或 JSON 檔案。 例如:

    $params = "{ 'name': 'firstMsi', 'location': 'northeurope' }"
    az devcenter dev environment create --dev-center-name <devcenterName>
        --project-name <projectName> --environment-name <environmentName> --environment-type <environmentType>
        --environment-definition-name <environmentDefinitionName> --catalog-name <catalogName>
        --parameters $params
    

備註

您可以使用 --help 來檢視任何命令的更多詳細資料,包括接受的引數和範例。 例如,用於 az devcenter dev environment create --help 檢視有關建立環境的更多詳細資訊。

排解權限錯誤

您必須具有 部署環境 使用者角色、 開發人員中心專案管理員 角色,或具有建立環境所需權限的 內建角色 。

如果您沒有正確的權限,則無法建立環境。 可能會出現類似下列範例的錯誤訊息:

(EnvironmentNotFound) The environment resource was not found.
Code: EnvironmentNotFound
Message: The environment resource was not found.

要解決問題,請指派正確的權限。 請參閱 授予開發團隊存取權。

存取環境

若要存取環境:

  1. 列出特定專案中可用的現有環境:

    az devcenter dev environment list --dev-center-name <devcenterName> --project-name <projectName>
    
  2. 檢視 ARM 範本輸出中定義的各種資源的存取端點。

  3. 使用端點存取特定資源。

部署環境

az devcenter dev environment deploy --action-id "deploy" --dev-center-name <devcenterName> \
    -g <resourceGroupName> --project-name <projectName> --environment-name <environmentName> --parameters <parametersJsonString>

刪除環境

az devcenter dev environment delete --dev-center-name <devcenterName>  --project-name <projectName> --environment-name <environmentName> --user-id "me"