Skip to content

Commit c5c6057

Browse files
committed
Updates to CLI commands for consistency
1 parent f5731c7 commit c5c6057

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed
Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Manage your environment
33
titleSuffix: Azure Deployment Environments
4-
description: Learn how to manage your environments in the developer portal or by using the Azure CLI.
4+
description: Learn how to manage your deployment environments in the developer portal or by using the Azure CLI.
55
author: RoseHJM
66
ms.author: rosemalcolm
77
ms.service: deployment-environments
8-
ms.topic: quickstart
9-
ms.date: 02/24/2023
8+
ms.topic: how-to
9+
ms.date: 02/28/2023
1010
---
1111

1212
# Manage your environment
@@ -22,15 +22,15 @@ As a developer, you can create and manage your environments from the developer p
2222

2323
## Manage an environment by using the developer portal
2424

25-
The developer portal provides a graphical interface for creation and management tasks and provides a visual status for your environments and dev boxes. You can create, redeploy, and delete your environments as needed.
25+
The developer portal provides a graphical interface for creation and management tasks and provides a visual status for your environments and dev boxes. You can create, redeploy, and delete your environments as needed.
2626

27-
### Create an environment
27+
### Create an environment by using the developer portal
2828

2929
1. Sign in to the [developer portal](https://devportal.microsoft.com).
3030
1. From the **New** menu at the top right, select **New environment**.
31-
31+
3232
:::image type="content" source="media/how-to-manage-environments/new-environment.png" alt-text="Screenshot showing the new menu with new environment highlighted.":::
33-
33+
3434
1. In the Add an environment pane, select the following information:
3535

3636
|Field |Value |
@@ -42,62 +42,62 @@ The developer portal provides a graphical interface for creation and management
4242

4343
:::image type="content" source="media/how-to-manage-environments/add-environment.png" alt-text="Screenshot showing add environment pane.":::
4444

45-
If your environment is configured to accept parameters, you're able to enter them on a separate pane. If your environment doesn't use parameters, select Create.
45+
If parameters are defined on the catalog item, you're prompted to enter them on a separate pane. If your environment doesn't use parameters, select Create.
4646

4747
:::image type="content" source="media/how-to-manage-environments/parameter-pane.png" alt-text="Screenshot showing the parameter pane.":::
4848

4949
1. Select **Create**. You see the environment tile in the developer portal immediately, displaying the **Creating...** status while creation is in progress.
50-
50+
5151
1. To view the resources created for the environment, select **Environment Resources**.
52-
52+
5353
:::image type="content" source="media/how-to-manage-environments/environment-resources-link.png" alt-text="Screenshot showing an environment tile with the Environment Resources link highlighted. ":::
5454

5555
1. The environment resources display in the Azure portal.
5656

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

59-
60-
### Redeploy an environment
59+
### Redeploy an environment by using the developer portal
6160

6261
When you need to update your environment parameters, you can redeploy it. The redeployment process updates any existing resources with changed properties and creates any new resources from the catalog item in the environment resource group.
6362

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

6665
1. On the environment you want to redeploy, from the options menu, select **Redeploy**.
67-
66+
6867
:::image type="content" source="media/how-to-manage-environments/option-redeploy.png" alt-text="Screenshot showing an environment tile with the options menu expanded and the redeploy option selected.":::
6968

70-
1. If your environment includes configurable parameters, you're prompted to make any changes you want. When you've made your changes, select **Redeploy**.
71-
69+
1. If parameters are defined on the catalog item, you're prompted to make any changes you want. When you've made your changes, select **Redeploy**.
70+
7271
:::image type="content" source="media/how-to-manage-environments/redeploy-parameters.png" alt-text="Screenshot showing the redeploy parameters pane.":::
7372

74-
1. If your environment does not include configurable parameters, you see the Redeploy *environment name* message. Select **Redeploy**.
73+
1. If your environment doesn't include configurable parameters, you see the Redeploy *environment name* message. Select **Redeploy**.
7574

7675
:::image type="content" source="media/how-to-manage-environments/confirm-redeploy.png" alt-text="Screenshot showing redeploy confirmation message with redeploy highlighted.":::
7776

7877
1. The environment displays the **Redeploying...** status while the redeployment takes place.
79-
78+
8079
1. To view the redeployed resources, select **Environment Resources**.
81-
80+
8281
1. The environment resources display in the Azure portal.
8382

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

86-
### Delete an environment
87-
You can delete your environment completely when you don't need it anymore.
85+
### Delete an environment by using the developer portal
86+
87+
You can delete your environment completely when you don't need it anymore.
8888

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

9191
1. On the environment you want to redeploy, from the options menu, select **Delete**.
92-
92+
9393
:::image type="content" source="media/how-to-manage-environments/option-delete.png" alt-text="Screenshot showing an environment tile with the options menu expanded and the delete option selected.":::
9494

9595
1. In the confirmation message, select **Delete**
96-
96+
9797
:::image type="content" source="media/how-to-manage-environments/confirm-delete.png" alt-text="Screenshot showing a confirm deletion message with Delete highlighted.":::
9898

9999
1. The environment tile displays the status **Deleting...** while the deletion is in progress.
100-
100+
101101
## Manage an environment by using the Azure CLI
102102

103103
The Azure CLI provides a command line interface for speed and efficiency when creating 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.
@@ -108,31 +108,31 @@ To learn how to Deployment Environments Azure CLI Extension, refer to [Configure
108108

109109
```azurecli
110110
az devcenter dev environment create --dev-center-name <devcenter-name> \
111-
--project-name <project-name> -n <name> --environment-type <environment-type-name> \
111+
--project-name <project-name> --environment-name <environment-name> --environment-type <environment-type-name> \
112112
--catalog-item-name <catalog-item-name> ---catalog-name <catalog-name> \
113113
--parameters <deployment-parameters-json-string>
114114
```
115115

116116
### List environments in a project
117117

118118
```azurecli
119-
az devcenter dev environment list --dev-center <devcenter-name> --project-name <project-name>
119+
az devcenter dev environment list --dev-center-name <devcenter-name> --project-name <project-name>
120120
```
121121

122122
### Deploy an environment
123123

124124
```azurecli
125-
az devcenter environment deploy-action --action-id "deploy" --dev-center <devcenter-name> \
126-
-g <resource-group-name> --project-name <project-name> -n <name> --parameters <parameters-json-string>
125+
az devcenter dev environment deploy-action --action-id "deploy" --dev-center-name <devcenter-name> \
126+
-g <resource-group-name> --project-name <project-name> --environment-name <environment-name> --parameters <parameters-json-string>
127127
```
128128

129129
### Delete an environment
130130

131131
```azurecli
132-
az devcenter dev environment delete --dev-center <devcenter-name> --project-name <project-name> -n <name> --user-id "me"
132+
az devcenter dev environment delete --dev-center-name <devcenter-name> --project-name <project-name> --environment-name <environment-name> --user-id "me"
133133
```
134134

135135
## Next steps
136136

137137
- Learn about configuring Azure Deployment Environments: [Quickstart: Create and configure a dev center](quickstart-create-and-configure-devcenter.md)
138-
- Learn more about managing your environments with the CLI: [Create and access an environment by using the Azure CLI](how-to-create-access-environments.md)
138+
- Learn more about managing your environments with the CLI: [Create and access an environment by using the Azure CLI](how-to-create-access-environments.md)
-642 Bytes
Loading

0 commit comments

Comments
 (0)