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/deployment-environments/concept-environment-yaml.md
+31-28Lines changed: 31 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,23 +5,24 @@ author: RoseHJM
5
5
ms.author: rosemalcolm
6
6
ms.service: azure-deployment-environments
7
7
ms.topic: concept-article
8
-
ms.date: 11/17/2023
8
+
ms.date: 03/20/2025
9
9
10
-
# Customer intent: As a developer, I want to know which parameters I can assign for parameters in environment.yaml.
10
+
# Customer intent: As a developer, I want to know the properties and parameters that I can use in environment.yaml.
11
11
12
12
---
13
13
14
-
# Parameters and data types in environment.yaml
14
+
# Properties and parameters in environment.yaml
15
15
16
-
ADE environment definitions are infrastructure as code (IaC), written in Bicep or Terraform, stored in repositories. Environment definitions can be modified and adapted for your specific requirements and then used to create a deployment environment on Azure. The environment.yaml schema defines and describes the types of Azure resources included in environment definitions.
16
+
Azure Deployment Environments environment definitions are infrastructure as code (IaC) that are written in Bicep or Terraform and stored in repositories. You can modify and adapt environment definitions for your requirements and then use them to create a deployment environment on Azure. The environment.yaml schema defines and describes the types of Azure resources included in environment definitions.
17
17
18
18
19
19
## What is environment.yaml?
20
20
21
21
The environment.yaml file acts as a manifest, describing the resources used and the template location for the environment definition.
22
22
23
23
### Sample environment.yaml
24
-
The following script is a generic example of an environment.yaml required for your environment definition.
24
+
25
+
The following script is an example of the environment.yaml that's required for your environment definition.
25
26
26
27
```yml
27
28
name: WebApp
@@ -31,26 +32,28 @@ description: Deploys a web app in Azure without a datastore
31
32
runner: ARM
32
33
templatePath: azuredeploy.json
33
34
```
35
+
34
36
### Definitions
37
+
35
38
The following table describes the properties that you can use in environment.yaml.
| `name` | string | The display name of the catalog item. | Yes | WebApp |
43
+
| `version` | string | The version of the catalog item. | No | 1.0.0 |
44
+
| `summary` | string | A short string that summarizes the catalog item. | No | Azure Web App Environment |
45
+
| `description` | string | A description of the catalog item. | No | Deploys a web app in Azure without a datastore |
46
+
| `runner` | string | The container image to use when running actions. | No | ARM template </br> Terraform |
47
+
| `templatePath` | string | The relative path of the entry template file. | Yes | main.tf </br> main.bicep </br> azuredeploy.json |
48
+
| `parameters` | array | Input parameters to use when creating the environment and running actions. | No | #/definitions/Parameter |
46
49
47
50
## Parameters in environment.yaml
48
51
49
-
Parameters enable you to reuse an environment definition in different scenarios. For example, you might want developers in different regions to deploy the same environment. You can define a location parameter to prompt the developer to enter the desired location as they create their environment.
52
+
Parameters enable you to reuse an environment definition in different scenarios. For example, you might want developers in different regions to deploy the same environment. You can define a location parameter to prompt developers to enter the desired location as they create their environments.
50
53
51
54
### Sample environment.yaml with parameters
52
55
53
-
The following script is an example of a environment.yaml file that includes two parameters;`location` and `name`:
56
+
The following script is an example of a environment.yaml file that includes two parameters:`location`and `name`.
54
57
55
58
```yml
56
59
name: WebApp
@@ -79,20 +82,20 @@ The following table describes the data types that you can use in environment.yam
79
82
80
83
Each parameter can use any of the following properties:
| name | string | Display name of the parameter. | |
86
-
| description | string | Description of the parameter. | |
87
-
| default | array </br> boolean </br> integer </br> number </br> object </br> string | The default value of the parameter. | |
88
-
| type| array </br> boolean </br> integer </br> number </br> object </br> string | The data type of the parameter. This data type must match the parameter data type in the ARM template, BICEP file, or Terraform file with the corresponding parameter name. | **Default type:** string |
89
-
| readOnly| boolean | Whether or not this parameter is read-only. | |
90
-
| required | boolean | Whether or not this parameter is required. | |
| `id ` | string | A unique ID of the parameter. | |
88
+
| `name` | string | A display name for the parameter. | |
89
+
| `description` | string | A description of the parameter. | |
90
+
| `default` | array </br> boolean </br> integer </br> number </br> object </br> string | The default value of the parameter. | |
91
+
| `type`| array </br> boolean </br> integer </br> number </br> object </br> string | The data type of the parameter. This data type must match the parameter data type that has the corresponding parameter name in the ARM template, Bicep file, or Terraform file. | **Default type:** string |
92
+
| `readOnly`| boolean | Whether the parameter is read-only. | |
93
+
| `required` | boolean | Whether the parameter is required. | |
There's a defined schema for Azure Deployment Environments environment.yaml files, which can make editing these files a little easier. You can add the schema definition to the beginning of your environment.yaml file:
98
+
There's a defined schema for Azure Deployment Environments environment.yaml files. It can make editing these files a little easier. You can add the schema definition to the beginning of your environment.yaml file:
0 commit comments