Skip to content

Commit ac2fc90

Browse files
author
RoseHJM
committed
Formatting
1 parent e041b82 commit ac2fc90

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

articles/dev-box/reference-dev-box-customizations.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ ms.author: rosemalcolm
99

1010
---
1111

12-
# Reference: imagedefinition.yaml files
12+
# Customizations Schema Reference
13+
14+
15+
## imagedefinition.yaml files
1316

1417
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.
1518

@@ -25,7 +28,7 @@ tasks:
2528
command:
2629
```
2730

28-
**name**
31+
### name
2932

3033
**Required**
3134

@@ -35,7 +38,7 @@ A friendly name for the image definition associated with this devbox.yaml. This
3538
name: myVSDevBox
3639
```
3740

38-
**image**
41+
### image
3942

4043
**Required**
4144

@@ -63,7 +66,7 @@ You would need the DevCenter az cli extension:
6366
az extension add --name devcenter
6467
```
6568

66-
**tasks**
69+
### tasks
6770

6871
**Required**
6972

@@ -90,11 +93,11 @@ tasks:
9093
timeout: 1800 # in seconds
9194
```
9295

93-
**Built-in tasks**
96+
### Built-in tasks
9497

9598
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.
9699

97-
**Winget built-in task**
100+
#### Winget built-in task
98101

99102
Applies a winget configuration to the Dev Box.
100103

@@ -127,7 +130,7 @@ Applies a winget configuration to the Dev Box.
127130
- If a config yaml file is provided under other parameters, there's no need for the package version.
128131
- required: false
129132

130-
**Powershell built-in task**
133+
#### Powershell built-in task
131134

132135
Execute a PowerShell command.
133136

@@ -138,9 +141,7 @@ Execute a PowerShell command.
138141
- The command to execute.
139142
- required: true
140143

141-
## Reference: task.yaml files
142-
143-
**task.yaml**
144+
## task.yaml files
144145

145146
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.
146147

@@ -166,9 +167,9 @@ inputs:
166167
description: The working directory to execute the command in
167168
```
168169

169-
**Attributes:**
170+
### Attributes:
170171

171-
- **name**
172+
#### name
172173
**Required**
173174
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.
174175
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:
177178
name: powershell
178179
```
179180

180-
- **description**
181+
#### description
181182
**Optional**
182183
Description of the task.
183184

184185
```
185186
description: This task executes a powershell command
186187
```
187188

188-
- **inputs**
189+
#### inputs
189190
**Required**
190191
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:
191192

@@ -203,46 +204,46 @@ inputs:
203204
description: The command to execute
204205
```
205206

206-
- **command**
207+
#### command
207208
**Required**
208209
The command to execute to fulfill this task. The provided command string would be executed in Windows PowerShell on the local machine.
209210

210211
```
211212
command: ".\runcommand.ps1
212213
```
213214

214-
- **Referencing Variables in command**
215+
#### Referencing Variables in command
215216
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.
216217

217218
```
218219
command: ".\runcommand.ps1 -command {{command}} -workingDirectory {{workingDirectory}}"
219220
```
220221

221-
- **timeout**
222+
#### timeout
222223
**Optional**
223224
The maximum amount of time (in minutes) to wait for task execution to complete, before timing out the task. Defaults to 30 minutes.
224225

225226
```
226227
timeout: 30
227228
```
228229

229-
- **author**
230+
#### author
230231
**Optional**
231232
Identifier of a task author – to help with audits and troubleshooting.
232233

233234
```
234235
author: Contoso Corporation
235236
```
236237

237-
- **documentationURL**
238+
#### documentationURL
238239
**Optional**
239240
Link to documentation for this task.
240241

241242
```
242243
documentationURL: "https://link.to/documentation"
243244
```
244245

245-
- **licenseURL**
246+
#### licenseURL
246247
**Optional**
247248
Link to the license for this task.
248249

0 commit comments

Comments
 (0)