1
1
---
2
- title : Configure and use Deployment Environments Azure CLI extension
2
+ title : Configure and use the Deployment Environments Azure CLI extension
3
3
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.
5
5
ms.service : deployment-environments
6
6
ms.custom : ignite-2022
7
7
ms.author : rosemalcolm
@@ -20,37 +20,42 @@ This article shows you how to use the Deployment Environments Azure CLI extensio
20
20
## Setup
21
21
22
22
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:
25
23
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:
27
26
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**
34
38
35
- **Manual install**
36
-
37
- Run the following command in the Azure CLI:
39
+ - Run the following command in the Azure CLI:
38
40
```azurecli
39
41
az extension add --source https://fidalgosetup.blob.core.windows.net/cli-extensions/devcenter-0.1.0-py3-none-any.whl
40
42
```
41
- 1. Sign in to Azure CLI.
43
+
44
+ 1. Sign in to the Azure CLI:
45
+
42
46
```azurecli
43
47
az login
44
48
```
45
49
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
+
47
52
```azurecli
48
53
az account set --subscription {subscriptionId}
49
54
```
50
55
51
56
## Commands
52
57
53
- ** Create a new resource group**
58
+ ### Create a new resource group
54
59
55
60
```azurecli
56
61
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
62
67
az configure --defaults group=<resource-group-name>
63
68
```
64
69
65
- ** Get help for a command**
70
+ ### Get help for a command
66
71
67
72
``` azurecli
68
73
az devcenter admin <command> --help
69
74
```
75
+
70
76
``` azurecli
71
77
az devcenter dev <command> --help
72
78
```
73
79
74
80
### Dev centers
75
81
76
- ** Create a dev center with User Assigned identity**
82
+ #### Create a dev center with user-assigned identity
77
83
78
84
``` azurecli
79
85
az devcenter admin devcenter create --identity-type "UserAssigned" --user-assigned-identity
80
86
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" --location <location-name> -g <resource-group-name> - <name>
81
87
```
82
88
83
- ** Create a dev center with System Assigned identity**
89
+ #### Create a dev center with system-assigned identity
84
90
85
91
``` azurecli
86
92
az devcenter admin devcenter create --location <location-name> -g <resource-group-name> -n <name> \
87
93
--identity-type "SystemAssigned"
88
94
```
89
95
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)
91
97
92
98
``` azurecli
93
99
az devcenter admin devcenter list --output table
94
100
```
95
101
96
- ** List dev centers (in the specified resource group)**
102
+ #### List dev centers (in the specified resource group)
97
103
98
104
``` azurecli
99
105
az devcenter admin devcenter list -g <resource-group-name>
100
106
```
101
107
102
- ** Get a specific dev center**
108
+ #### Get a specific dev center
103
109
104
110
``` azurecli
105
111
az devcenter admin devcenter show -g <resource-group-name> --name <name>
106
112
```
107
113
108
- ** Delete a dev center**
114
+ #### Delete a dev center
109
115
110
116
``` azurecli
111
117
az devcenter admin devcenter delete -g <resource-group-name> --name <name>
112
118
```
113
119
114
- ** Force delete a dev center**
120
+ #### Force- delete a dev center
115
121
116
122
``` azurecli
117
123
az devcenter admin devcenter delete -g <resource-group-name> --name <name> --yes
118
124
```
119
125
120
- ### Environment Types
126
+ ### Environment types
121
127
122
- ** Create an Environment Type **
128
+ #### Create an environment type
123
129
124
130
``` azurecli
125
131
az devcenter admin environment-type create --dev-center-name <devcenter-name> -g <resource-group-name> --name <name>
126
132
```
127
133
128
- ** List environment types by dev center**
134
+ #### List environment types by dev center
129
135
130
136
``` azurecli
131
137
az devcenter admin environment-type list --dev-center-name <devcenter-name> --resource-group <resource-group-name>
132
138
```
133
139
134
- ** List environment types by project**
140
+ #### List environment types by project
135
141
136
142
``` azurecli
137
143
az devcenter admin environment-type list --project-name <devcenter-name> --resource-group <resource-group-name>
138
144
```
139
145
140
- ** Delete an environment type**
146
+ #### Delete an environment type
141
147
142
148
``` azurecli
143
149
az devcenter admin environment-type delete --dev-center-name <devcenter-name> --name "{environmentTypeName}" \
144
150
--resource-group <resource-group-name>
145
151
```
146
152
147
- ** List environment types by dev center and project for developers**
153
+ #### List environment types by dev center and project for developers
148
154
149
155
``` azurecli
150
156
az devcenter dev environment list --dev-center <devcenter-name> --project-name <project-name>
151
157
```
152
158
153
159
### Project Environment Types
154
160
155
- ** Create project environment types**
161
+ #### Create project environment types
156
162
157
163
``` azurecli
158
164
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
161
167
--status Enabled --type SystemAssigned
162
168
```
163
169
164
- ** List project environment types by dev center**
170
+ #### List project environment types by dev center
165
171
166
172
``` azurecli
167
173
az devcenter admin project-environment-type list --dev-center-name <devcenter-name> \
168
174
--resource-group <resource-group-name>
169
175
```
170
176
171
- ** List project environment types by project**
177
+ #### List project environment types by project
172
178
173
179
``` azurecli
174
180
az devcenter admin project-environment-type list --project-name <project-name> --resource-group <resource-group-name>
175
181
```
176
182
177
- ** Delete project environment types**
183
+ #### Delete project environment types
178
184
179
185
``` azurecli
180
186
az devcenter admin project-environment-type delete --project-name <project-name> \
181
187
--environment-type-name "{environmentTypeName}" --resource-group <resource-group-name>
182
188
```
183
189
184
- ** List allowed project environment types**
190
+ #### List allowed project environment types
185
191
186
192
``` azurecli
187
193
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
190
196
191
197
### Catalogs
192
198
193
- ** Create a catalog with a GitHub repository**
199
+ #### Create a catalog with a GitHub repository
194
200
195
201
``` azurecli
196
202
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>
197
203
```
198
204
199
- ** Create a catalog with a Azure DevOps repository**
205
+ #### Create a catalog with a Azure DevOps repository
200
206
201
207
``` azurecli
202
208
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>
203
209
```
204
210
205
- ** Sync a catalog**
211
+ #### Sync a catalog
206
212
207
213
``` azurecli
208
214
az devcenter admin catalog sync --name <name> --dev-center-name <devcenter-name> -g <resource-group-name>
209
215
```
210
216
211
- ** List catalogs in a dev center**
217
+ #### List catalogs in a dev center
212
218
213
219
``` azurecli
214
220
az devcenter admin catalog list -g <resource-group-name> --dev-center-name <devcenter-name>
215
221
```
216
222
217
- ** Delete a catalog**
223
+ #### Delete a catalog
218
224
219
225
``` azurecli
220
226
az devcenter admin catalog delete -g <resource-group-name> --dev-center-name <devcenter-name> -n <name>
221
227
```
222
228
223
229
### Catalog items
224
230
225
- ** List catalog items available in a project**
231
+ #### List catalog items available in a project
226
232
227
233
``` azurecli
228
234
az devcenter dev catalog-item list --dev-center-name <devcenter-name> --project-name <name>
229
235
```
230
236
231
237
### Project
232
238
233
- ** Create a project**
239
+ #### Create a project
234
240
235
241
``` azurecli
236
242
az devcenter admin project create -g <resource-group-name> -n <project-name> --dev-center-id <devcenter-resource-id>
237
243
```
238
244
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)
240
246
241
247
``` azurecli
242
248
az graph query -q "Resources | where type =~ 'microsoft.devcenter/projects' | project id, name"
243
249
```
244
250
245
- ** List projects (in the specified resource group)**
251
+ #### List projects (in the specified resource group)
246
252
247
253
``` azurecli
248
254
az devcenter admin project list -g <resource-group-name>
249
255
```
250
256
251
- ** Delete a project**
257
+ #### Delete a project
252
258
253
259
``` azurecli
254
260
az devcenter admin project delete -g <resource-group-name> --name <project-name>
255
261
```
256
262
257
263
### Environments
258
264
259
- ** Create an environment**
265
+ #### Create an environment
260
266
261
267
``` azurecli
262
268
az devcenter dev environment create --dev-center-name <devcenter-name> \
@@ -265,20 +271,20 @@ az devcenter dev environment create --dev-center-name <devcenter-name> \
265
271
--parameters <deployment-parameters-json-string>
266
272
```
267
273
268
- ** Deploy an environment**
274
+ #### Deploy an environment
269
275
270
276
``` azurecli
271
277
az devcenter environment deploy-action --action-id "deploy" --dev-center <devcenter-name> \
272
278
-g <resource-group-name> --project-name <project-name> -n <name> --parameters <parameters-json-string>
273
279
```
274
280
275
- ** List environments in a project**
281
+ ### List environments in a project
276
282
277
283
``` azurecli
278
284
az devcenter dev environment list --dev-center <devcenter-name> --project-name <project-name>
279
285
```
280
286
281
- ** Delete an environment**
287
+ #### Delete an environment
282
288
283
289
``` azurecli
284
290
az devcenter dev environment delete --dev-center <devcenter-name> --project-name <project-name> -n <name> --user-id "me"
0 commit comments