You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/dev-box/reference-dev-box-customizations.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,10 @@ ms.author: rosemalcolm
9
9
10
10
---
11
11
12
-
# Reference: imagedefinition.yaml files
12
+
# Customizations Schema Reference
13
+
14
+
15
+
## imagedefinition.yaml files
13
16
14
17
A Dev Box yaml allows you to define customization tasks that ought to run during Dev Box creation. A devbox.yaml file might live in the same repository as the primary source code being used by the dev team, or in a centralized repository of configurations.
15
18
@@ -25,7 +28,7 @@ tasks:
25
28
command:
26
29
```
27
30
28
-
**name**
31
+
### name
29
32
30
33
**Required**
31
34
@@ -35,7 +38,7 @@ A friendly name for the image definition associated with this devbox.yaml. This
35
38
name: myVSDevBox
36
39
```
37
40
38
-
**image**
41
+
### image
39
42
40
43
**Required**
41
44
@@ -63,7 +66,7 @@ You would need the DevCenter az cli extension:
63
66
az extension add --name devcenter
64
67
```
65
68
66
-
**tasks**
69
+
### tasks
67
70
68
71
**Required**
69
72
@@ -90,11 +93,11 @@ tasks:
90
93
timeout: 1800 # in seconds
91
94
```
92
95
93
-
**Built-in tasks**
96
+
### Built-in tasks
94
97
95
98
PowerShell and Winget are available as built-in tasks and can be invoked directly without attaching a DevCenter-level catalog that defines the implementation of these tasks.
96
99
97
-
**Winget built-in task**
100
+
#### Winget built-in task
98
101
99
102
Applies a winget configuration to the Dev Box.
100
103
@@ -127,7 +130,7 @@ Applies a winget configuration to the Dev Box.
127
130
- If a config yaml file is provided under other parameters, there's no need for the package version.
128
131
- required: false
129
132
130
-
**Powershell built-in task**
133
+
#### Powershell built-in task
131
134
132
135
Execute a PowerShell command.
133
136
@@ -138,9 +141,7 @@ Execute a PowerShell command.
138
141
- The command to execute.
139
142
- required: true
140
143
141
-
## Reference: task.yaml files
142
-
143
-
**task.yaml**
144
+
## task.yaml files
144
145
145
146
Customization tasks are reusable units of installation code or environment configuration – written using PowerShell scripts and described using a task.yaml metadata file. These tasks are then used by devs to customize a dev box by referencing them from a devbox.yaml file.
146
147
@@ -166,9 +167,9 @@ inputs:
166
167
description: The working directory to execute the command in
167
168
```
168
169
169
-
**Attributes:**
170
+
### Attributes:
170
171
171
-
-**name**
172
+
#### name
172
173
**Required**
173
174
The unique identifier used to refer to a task from devbox.yaml. The name should be unique in the context of the catalog where the task exists.
174
175
Naming must match existing Azure Resource constraints: The name must be between 3 and 63 characters and must start with an alphanumeric character and consist of only alphanumeric characters and '-', '.', or '_'. The "/" character is reserved.
@@ -177,15 +178,15 @@ inputs:
177
178
name: powershell
178
179
```
179
180
180
-
-**description**
181
+
#### description
181
182
**Optional**
182
183
Description of the task.
183
184
184
185
```
185
186
description: This task executes a powershell command
186
187
```
187
188
188
-
-**inputs**
189
+
#### inputs
189
190
**Required**
190
191
List of parameters that this task takes as an input from a devbox.yaml and utilizes while executing the command. Each parent item represents the name of a parameter and supports these keys:
191
192
@@ -203,46 +204,46 @@ inputs:
203
204
description: The command to execute
204
205
```
205
206
206
-
-**command**
207
+
#### command
207
208
**Required**
208
209
The command to execute to fulfill this task. The provided command string would be executed in Windows PowerShell on the local machine.
209
210
210
211
```
211
212
command: ".\runcommand.ps1
212
213
```
213
214
214
-
-**Referencing Variables in command**
215
+
#### Referencing Variables in command
215
216
To reference parameters in a command, you can specify the variable name in Handlebar style double braces {{parameter_name}}. The values of these variables are interpolated before your command is executed.
0 commit comments