Skip to content

Commit 347a0e9

Browse files
authored
Merge pull request #290358 from MicrosoftDocs/release-ignite-deployment-environments
Ignite 2024 ship room - Force delete - Azure Deployment Environments - #335707
2 parents 1a3d262 + cf514a9 commit 347a0e9

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

articles/deployment-environments/how-to-manage-environments.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ ms.author: rosemalcolm
77
ms.service: azure-deployment-environments
88
ms.custom: devx-track-azurecli, build-2023
99
ms.topic: how-to
10-
ms.date: 12/07/2023
10+
ms.date: 11/06/2024
11+
12+
# customer intent: As a developer, I want to learn how to manage my environments in Azure Deployment Environments so that I can create, redeploy, and delete my environments as needed.
1113
---
1214

1315
# Manage environments in Azure Deployment Environments
1416

15-
In this article, you learn how to manage environments in Azure Deployment Environments. As a developer, you can create and manage your environments from the developer portal or by using the Azure CLI.
17+
In this article, you learn how to manage environments in Azure Deployment Environments (ADE). As a developer, you can create and manage your environments from the developer portal or by using the Azure CLI.
1618

1719
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 preconfigured environment types. The permissions are defined in the specific environment type.
1820

@@ -21,11 +23,13 @@ In Azure Deployment Environments, a platform engineer gives developers access to
2123
- Access to a project that has at least one environment type.
2224
- The [Deployment Environments User](how-to-configure-deployment-environments-user.md) role, the [DevCenter Project Admin](how-to-configure-project-admin.md) role, or a [built-in role](../role-based-access-control/built-in-roles.md) that has the required permissions to create an environment.
2325

24-
## Manage an environment by using the developer portal
26+
## Create an environment by using the developer portal
2527

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

28-
### Create an environment by using the developer portal
30+
When you create a deployment environment, ADE uses the environment definition to define the resources for your environment and creates a resource group to store them.
31+
32+
To create a deployment environment in the developer portal, follow these steps:
2933

3034
1. Sign in to the [developer portal](https://devportal.microsoft.com).
3135

@@ -46,7 +50,7 @@ The developer portal provides a graphical interface for development teams to cre
4650

4751
If your environment is configured to accept parameters, you can enter them on a separate pane.
4852

49-
:::image type="content" source="media/how-to-manage-environments/parameter-pane.png" alt-text="Screenshot showing the parameter pane." lightbox="media/how-to-manage-environments/parameter-pane.png":::
53+
:::image type="content" source="media/how-to-manage-environments/parameter-pane.png" alt-text="Screenshot of the developer portal showing the parameter pane." lightbox="media/how-to-manage-environments/parameter-pane.png":::
5054

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

@@ -58,9 +62,9 @@ The developer portal provides a graphical interface for development teams to cre
5862

5963
:::image type="content" source="media/how-to-manage-environments/environment-resources.png" alt-text="Screenshot showing environment resources in the Azure portal." lightbox="media/how-to-manage-environments/environment-resources.png":::
6064

61-
### Redeploy an environment by using the developer portal
65+
## Redeploy an environment by using the developer portal
6266

63-
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.
67+
When you need to update your deployment 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.
6468

6569
1. Sign in to the [developer portal](https://devportal.microsoft.com).
6670

@@ -82,9 +86,9 @@ When you need to update your environment, you can redeploy it. The redeployment
8286

8387
:::image type="content" source="media/how-to-manage-environments/redeployed-resources.png" alt-text="Screenshot showing redeployed resources in the Azure portal." lightbox="media/how-to-manage-environments/redeployed-resources.png":::
8488

85-
### Delete an environment by using the developer portal
89+
## Delete an environment by using the developer portal
8690

87-
You can delete your environment completely when you don't need it anymore.
91+
You can delete your deployment environment completely when you don't need it anymore. ADE uses the resource group and environment definition to identify and delete the resources created for the deployment environment.
8892

8993
1. Sign in to the [developer portal](https://devportal.microsoft.com).
9094

@@ -98,6 +102,28 @@ You can delete your environment completely when you don't need it anymore.
98102

99103
1. The environment tile displays the status **Deleting...** while the deletion is in progress.
100104

105+
## Force delete an environment
106+
107+
An attempt to delete a deployment environment might fail due to issues like the environment definition being missing or inaccessible. It can also fail if the Azure Container Registry (ACR) that holds a custom runner isn't available, if Azure Deployment Environments (ADE) can't access the runner, or if updates cause the runner to function incorrectly.
108+
109+
If the deletion fails, you can forcibly delete the environment. Force delete deletes the environment, its deployment resource group, and all resources in the deployment resource group. Any resources created outside the resource group are orphaned; force delete doesn't delete them.
110+
111+
To forcibly delete an environment, follow these steps:
112+
1. Open the CLI.
113+
1. Run the following command to forcibly delete the environment:
114+
115+
```bash
116+
az devcenter environment delete --name <environment-name> --dev-center <dev-center-name> --project-name <project-name> --force
117+
```
118+
119+
Replace `<environment-name>` with the name of the environment you want to delete, `<dev-center-name>` with the name of your dev center, and `<project-name>` with the name of the project that the environment belongs to.
120+
121+
For more information about the `az devcenter environment delete` command, see [az devcenter environment delete](/cli/azure/devcenter/dev/environment).
122+
123+
> [!IMPORTANT]
124+
> The force delete feature is currently in PREVIEW.
125+
> For more information about the preview status, see the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). The document defines legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
126+
101127
## Manage an environment by using the Azure CLI
102128

103129
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 *devcenter* Azure CLI extension to create, list, deploy, or delete an environment in Azure Deployment Environments.

0 commit comments

Comments
 (0)