Skip to content

Commit 8bc82d8

Browse files
committed
edits
1 parent 6a82096 commit 8bc82d8

File tree

1 file changed

+56
-50
lines changed

1 file changed

+56
-50
lines changed

articles/deployment-environments/how-to-configure-use-cli.md

Lines changed: 56 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Configure and use Deployment Environments Azure CLI extension
2+
title: Configure and use the Deployment Environments Azure CLI extension
33
titleSuffix: Azure Deployment Environments
4-
description: Learn how to setup and use Deployment Environments Azure CLI extension to configure the Azure Deployment environments service.
4+
description: Learn how to set up and use the Azure Deployment Environments Preview Azure CLI extension to configure the Deployment Environments service.
55
ms.service: deployment-environments
66
ms.custom: ignite-2022
77
ms.author: rosemalcolm
@@ -20,37 +20,42 @@ This article shows you how to use the Deployment Environments Azure CLI extensio
2020
## Setup
2121

2222
1. Install the Deployment Environments Azure CLI Extension:
23-
- [Download and install the Azure CLI](/cli/azure/install-azure-cli).
24-
- Install the Deployment Environments AZ CLI extension:
2523

26-
**Automated install**
24+
1. [Download and install the Azure CLI](/cli/azure/install-azure-cli).
25+
1. Install the Deployment Environments AZ CLI extension:
2726

28-
Execute the script https://aka.ms/DevCenter/Install-DevCenterCli.ps1 directly in PowerShell to install:
29-
```powershell
30-
iex "& { $(irm https://aka.ms/DevCenter/Install-DevCenterCli.ps1 ) }"
31-
```
32-
33-
This will uninstall any existing dev center extension and install the latest version.
27+
- **Automated installation**
28+
29+
Execute the script https://aka.ms/DevCenter/Install-DevCenterCli.ps1 directly in PowerShell to install:
30+
31+
```powershell
32+
iex "& { $(irm https://aka.ms/DevCenter/Install-DevCenterCli.ps1 ) }"
33+
```
34+
35+
Any existing dev center extension is uninstalled and the latest version is installed.
36+
37+
- **Manual installation**
3438
35-
**Manual install**
36-
37-
Run the following command in the Azure CLI:
39+
- Run the following command in the Azure CLI:
3840
```azurecli
3941
az extension add --source https://fidalgosetup.blob.core.windows.net/cli-extensions/devcenter-0.1.0-py3-none-any.whl
4042
```
41-
1. Sign in to Azure CLI.
43+
44+
1. Sign in to the Azure CLI:
45+
4246
```azurecli
4347
az login
4448
```
4549
46-
1. Set the default subscription to the subscription where you'll be creating your specific Deployment Environment resources.
50+
1. Set the default subscription to the subscription in which you'll create your specific Deployment Environment resources.
51+
4752
```azurecli
4853
az account set --subscription {subscriptionId}
4954
```
5055
5156
## Commands
5257
53-
**Create a new resource group**
58+
### Create a new resource group
5459
5560
```azurecli
5661
az group create -l <region-name> -n <resource-group-name>
@@ -62,97 +67,98 @@ Optionally, set defaults (which means there is no need to pass the argument into
6267
az configure --defaults group=<resource-group-name>
6368
```
6469

65-
**Get help for a command**
70+
### Get help for a command
6671

6772
```azurecli
6873
az devcenter admin <command> --help
6974
```
75+
7076
```azurecli
7177
az devcenter dev <command> --help
7278
```
7379

7480
### Dev centers
7581

76-
**Create a dev center with User Assigned identity**
82+
#### Create a dev center with user-assigned identity
7783

7884
```azurecli
7985
az devcenter admin devcenter create --identity-type "UserAssigned" --user-assigned-identity
8086
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" --location <location-name> -g <resource-group-name> - <name>
8187
```
8288

83-
**Create a dev center with System Assigned identity**
89+
#### Create a dev center with system-assigned identity
8490

8591
```azurecli
8692
az devcenter admin devcenter create --location <location-name> -g <resource-group-name> -n <name> \
8793
--identity-type "SystemAssigned"
8894
```
8995

90-
**List dev centers (in the selected subscription if resource group is not specified or configured in defaults)**
96+
#### List dev centers (in the selected subscription if resource group is not specified or configured in defaults)
9197

9298
```azurecli
9399
az devcenter admin devcenter list --output table
94100
```
95101

96-
**List dev centers (in the specified resource group)**
102+
#### List dev centers (in the specified resource group)
97103

98104
```azurecli
99105
az devcenter admin devcenter list -g <resource-group-name>
100106
```
101107

102-
**Get a specific dev center**
108+
#### Get a specific dev center
103109

104110
```azurecli
105111
az devcenter admin devcenter show -g <resource-group-name> --name <name>
106112
```
107113

108-
**Delete a dev center**
114+
#### Delete a dev center
109115

110116
```azurecli
111117
az devcenter admin devcenter delete -g <resource-group-name> --name <name>
112118
```
113119

114-
**Force delete a dev center**
120+
#### Force-delete a dev center
115121

116122
```azurecli
117123
az devcenter admin devcenter delete -g <resource-group-name> --name <name> --yes
118124
```
119125

120-
### Environment Types
126+
### Environment types
121127

122-
**Create an Environment Type**
128+
#### Create an environment type
123129

124130
```azurecli
125131
az devcenter admin environment-type create --dev-center-name <devcenter-name> -g <resource-group-name> --name <name>
126132
```
127133

128-
**List environment types by dev center**
134+
#### List environment types by dev center
129135

130136
```azurecli
131137
az devcenter admin environment-type list --dev-center-name <devcenter-name> --resource-group <resource-group-name>
132138
```
133139

134-
**List environment types by project**
140+
#### List environment types by project
135141

136142
```azurecli
137143
az devcenter admin environment-type list --project-name <devcenter-name> --resource-group <resource-group-name>
138144
```
139145

140-
**Delete an environment type**
146+
#### Delete an environment type
141147

142148
```azurecli
143149
az devcenter admin environment-type delete --dev-center-name <devcenter-name> --name "{environmentTypeName}" \
144150
--resource-group <resource-group-name>
145151
```
146152

147-
**List environment types by dev center and project for developers**
153+
#### List environment types by dev center and project for developers
148154

149155
```azurecli
150156
az devcenter dev environment list --dev-center <devcenter-name> --project-name <project-name>
151157
```
152158

153159
### Project Environment Types
154160

155-
**Create project environment types**
161+
#### Create project environment types
156162

157163
```azurecli
158164
az devcenter admin project-environment-type create --description "Developer/Testing environment" --dev-center-name \
@@ -161,27 +167,27 @@ az devcenter admin project-environment-type create --description "Developer/Test
161167
--status Enabled --type SystemAssigned
162168
```
163169

164-
**List project environment types by dev center**
170+
#### List project environment types by dev center
165171

166172
```azurecli
167173
az devcenter admin project-environment-type list --dev-center-name <devcenter-name> \
168174
--resource-group <resource-group-name>
169175
```
170176

171-
**List project environment types by project**
177+
#### List project environment types by project
172178

173179
```azurecli
174180
az devcenter admin project-environment-type list --project-name <project-name> --resource-group <resource-group-name>
175181
```
176182

177-
**Delete project environment types**
183+
#### Delete project environment types
178184

179185
```azurecli
180186
az devcenter admin project-environment-type delete --project-name <project-name> \
181187
--environment-type-name "{environmentTypeName}" --resource-group <resource-group-name>
182188
```
183189

184-
**List allowed project environment types**
190+
#### List allowed project environment types
185191

186192
```azurecli
187193
az devcenter admin project-allowed-environment-type list --project-name <project-name> \
@@ -190,73 +196,73 @@ az devcenter admin project-allowed-environment-type list --project-name <project
190196

191197
### Catalogs
192198

193-
**Create a catalog with a GitHub repository**
199+
#### Create a catalog with a GitHub repository
194200

195201
```azurecli
196202
az devcenter admin catalog create --git-hub secret-identifier="https://<key-vault-name>.azure-int.net/secrets/<secret-name>" uri=<git-clone-uri> branch=<git-branch> -g <resource-group-name> --name <name> --dev-center-name <devcenter-name>
197203
```
198204

199-
**Create a catalog with a Azure DevOps repository**
205+
#### Create a catalog with a Azure DevOps repository
200206

201207
```azurecli
202208
az devcenter admin catalog create --ado-git secret-identifier="https://<key-vault-name>.azure-int.net/secrets/<secret-name>" uri=<git-clone-uri> branch=<git-branch> -g <resource-group-name> --name <name> --dev-center-name <devcenter-name>
203209
```
204210

205-
**Sync a catalog**
211+
#### Sync a catalog
206212

207213
```azurecli
208214
az devcenter admin catalog sync --name <name> --dev-center-name <devcenter-name> -g <resource-group-name>
209215
```
210216

211-
**List catalogs in a dev center**
217+
#### List catalogs in a dev center
212218

213219
```azurecli
214220
az devcenter admin catalog list -g <resource-group-name> --dev-center-name <devcenter-name>
215221
```
216222

217-
**Delete a catalog**
223+
#### Delete a catalog
218224

219225
```azurecli
220226
az devcenter admin catalog delete -g <resource-group-name> --dev-center-name <devcenter-name> -n <name>
221227
```
222228

223229
### Catalog items
224230

225-
**List catalog items available in a project**
231+
#### List catalog items available in a project
226232

227233
```azurecli
228234
az devcenter dev catalog-item list --dev-center-name <devcenter-name> --project-name <name>
229235
```
230236

231237
### Project
232238

233-
**Create a project**
239+
#### Create a project
234240

235241
```azurecli
236242
az devcenter admin project create -g <resource-group-name> -n <project-name> --dev-center-id <devcenter-resource-id>
237243
```
238244

239-
**List projects (in the selected subscription if resource group is not specified or configured in defaults)**
245+
#### List projects (in the selected subscription if resource group is not specified or configured in defaults)
240246

241247
```azurecli
242248
az graph query -q "Resources | where type =~ 'microsoft.devcenter/projects' | project id, name"
243249
```
244250

245-
**List projects (in the specified resource group)**
251+
#### List projects (in the specified resource group)
246252

247253
```azurecli
248254
az devcenter admin project list -g <resource-group-name>
249255
```
250256

251-
**Delete a project**
257+
#### Delete a project
252258

253259
```azurecli
254260
az devcenter admin project delete -g <resource-group-name> --name <project-name>
255261
```
256262

257263
### Environments
258264

259-
**Create an environment**
265+
#### Create an environment
260266

261267
```azurecli
262268
az devcenter dev environment create --dev-center-name <devcenter-name> \
@@ -265,20 +271,20 @@ az devcenter dev environment create --dev-center-name <devcenter-name> \
265271
--parameters <deployment-parameters-json-string>
266272
```
267273

268-
**Deploy an environment**
274+
#### Deploy an environment
269275

270276
```azurecli
271277
az devcenter environment deploy-action --action-id "deploy" --dev-center <devcenter-name> \
272278
-g <resource-group-name> --project-name <project-name> -n <name> --parameters <parameters-json-string>
273279
```
274280

275-
**List environments in a project**
281+
### List environments in a project
276282

277283
```azurecli
278284
az devcenter dev environment list --dev-center <devcenter-name> --project-name <project-name>
279285
```
280286

281-
**Delete an environment**
287+
#### Delete an environment
282288

283289
```azurecli
284290
az devcenter dev environment delete --dev-center <devcenter-name> --project-name <project-name> -n <name> --user-id "me"

0 commit comments

Comments
 (0)