你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

使用 Azure CLI 创建和访问环境

本指南介绍如何使用 Azure CLI 在现有 Azure 部署环境项目中创建和访问 环境

先决条件

创建环境

创建环境会自动创建所需的资源以及用于存储它们的资源组。 资源组名称遵循模式 {projectName}-{environmentName}。 可以在 Azure 门户中查看该资源组。

在 Azure CLI 中完成以下步骤以创建环境和配置资源。 你可以查看特定 Azure 资源管理器模板(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 <devcenterName> --project-name <projectName> -o table
    
  7. 列出特定项目可以使用的环境定义

    az devcenter dev environment-definition list --dev-center <devcenterName> --project-name <projectName> -o table
    
  8. 使用环境定义(在 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>
    

    如果特定环境定义需要任意参数,请使用 --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 来查看有关创建环境的更多详细信息。

排查权限错误

必须拥有部署环境用户角色、DevCenter 项目管理员角色或具有所需权限的内置角色才能创建环境。

如果没有正确的权限,则无法创建环境。 可能会出现类似于以下示例的错误消息:

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

若要解决此问题,请分配正确的权限:为开发团队提供访问权限

访问环境

若要访问环境,请执行以下操作:

  1. 列出特定项目中可用的现有环境:

     az devcenter dev environment list --dev-center <devcenterName> --project-name <projectName>
    
  2. 查看 ARM 模板输出中定义的各种资源的访问终结点。

  3. 使用终结点访问特定资源。

部署环境

az devcenter dev environment deploy-action --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"