Manage your deployment environment

In Azure Deployment Environments, a platform engineer gives developers access to projects and the environment types that are associated with them. After a developer has access, they can create deployment environments based on the pre-configured environment types. The permissions that the creator of the environment and the rest of team have to access the environment's resources are defined in the specific environment type.

As a developer, you can create and manage your environments from the developer portal or by using the Azure CLI.

Prerequisites

Manage an environment by using the developer portal

The developer portal provides a graphical interface for development teams to create new environments and manage existing environments. You can create, redeploy, and delete your environments as needed in the developer portal.

Create an environment by using the developer portal

  1. Sign in to the developer portal.

  2. On the New menu at the top right, select New environment.

    Screenshot showing the new menu with new environment highlighted.

  3. In the Add an environment pane, enter or select the following information:

    Field Value
    Name Enter a descriptive name for your environment.
    Project Select the project you want to create the environment in. If you have access to more than one project, you see a list of the available projects.
    Type Select the environment type you want to create. If you have access to more than one environment type, you see a list of the available types.
    Environment definitions Select the environment definition you want to use to create the environment. You see a list of the environment definitions available in the catalogs associated with your dev center.

    Screenshot showing the add environment pane.

    If parameters are defined on the environment definition, you're prompted to enter them in a separate pane. If your environment doesn't use parameters, select Create.

    Screenshot showing the parameter pane.

  4. Select Create. The environment tile is shown in the developer portal immediately, displaying the Creating... status while creation is in progress.

  5. To view the resources that were created for the environment, select Environment Resources.

    Screenshot showing an environment tile with the Environment Resources link highlighted.

  6. The environment resources are displayed in the Azure portal.

    Screenshot showing environment resources in the Azure portal.

Redeploy an environment by using the developer portal

When you need to update your environment, you can redeploy it. The redeployment process updates any existing resources with changed properties or creates any new resources based on the latest configuration of the environment definition.

  1. Sign in to the developer portal.

  2. On the environment you want to redeploy, on the options menu, select Redeploy.

    Screenshot showing an environment tile with the options menu expanded and the redeploy option selected.

  3. If parameters are defined on the environment definition, you're prompted to make any changes you want to make. When you've made your changes, select Redeploy.

    Screenshot showing the redeploy parameters pane.

  4. If your environment doesn't include configurable parameters, you see the Redeploy <environment name> message. Select Redeploy.

    Screenshot showing the redeploy confirmation message with redeploy highlighted.

  5. The environment displays the Redeploying... status while the redeployment takes place. To view the redeployed resources, select Environment Resources.

    The environment resources are displayed in the Azure portal.

    Screenshot showing redeployed resources in the Azure portal.

Delete an environment by using the developer portal

You can delete your environment completely when you don't need it anymore.

  1. Sign in to the developer portal.

  2. On the environment you want to redeploy, on the options menu, select Delete.

    Screenshot showing an environment tile with the options menu expanded and the delete option selected.

  3. In the confirmation message, select Delete

    Screenshot showing a confirm deletion message with Delete highlighted.

  4. The environment tile displays the status Deleting... while the deletion is in progress.

Manage an environment by using the Azure CLI

The Azure CLI provides a command-line interface for speed and efficiency when you create multiple similar environments, or for platforms where resources like memory are limited. You can use the following commands to create, list, deploy, or delete an environment.

To learn how to use the Deployment Environments Azure CLI extension, see Configure Azure Deployment Environments by using the Azure CLI.

Create an environment

az devcenter dev environment create --dev-center-name <devcenter-name> \
    --project-name <project-name> --environment-name <environment-name> --environment-type <environment-type-name> \
    --environment-definition-name <environment-definition-name> ---catalog-name <catalog-name> \
    --parameters <deployment-parameters-json-string>

List environments in a project

az devcenter dev environment list --dev-center-name <devcenter-name> --project-name <project-name>

Deploy an environment

az devcenter dev environment deploy-action --action-id "deploy" --dev-center-name <devcenter-name> \
    -g <resource-group-name> --project-name <project-name> --environment-name <environment-name> --parameters <parameters-json-string>

Delete an environment

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

Next steps