Skip to content

Commit 850265a

Browse files
v-albemiv-albemi
committed
edits
1 parent 066d424 commit 850265a

File tree

1 file changed

+35
-32
lines changed

1 file changed

+35
-32
lines changed

‎articles/deployment-environments/concept-environment-yaml.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ ms.service: azure-deployment-environments
77
ms.topic: concept-article
88
ms.date: 03/20/2025
99

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 which parameters I can assign for parameters in manifest.yaml.
1111

1212
---
1313

14-
# Parameters and data types in environment.yaml
14+
# Parameters and data types in manifest.yaml
1515

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+
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 manifest.yaml schema defines and describes the types of Azure resources included in environment definitions.
1717

1818

19-
## What is environment.yaml?
19+
## What is manifest.yaml?
2020

21-
The environment.yaml file acts as a manifest, describing the resources used and the template location for the environment definition.
21+
The manifest.yaml file acts as a manifest, describing the resources used and the template location for the environment definition.
2222

23-
### Sample environment.yaml
24-
The following script is a generic example of an environment.yaml required for your environment definition.
23+
### Sample manifest.yaml
24+
25+
The following script is an example of a manifest.yaml required for your environment definition.
2526

2627
```yml
2728
name: WebApp
@@ -31,26 +32,28 @@ description: Deploys a web app in Azure without a datastore
3132
runner: ARM
3233
templatePath: azuredeploy.json
3334
```
35+
3436
### Definitions
35-
The following table describes the properties that you can use in environment.yaml.
3637
37-
| **Property** | **Type** | **Description** | **Required** | **Examples** |
38-
| ------------ | -------- | -------------------------------------------------- | ------------ | ----------------------------------------------- |
39-
| name | string | The display name of the catalog item. | Yes | |
40-
| version | string | The version of the catalog item. | | 1.0.0 |
41-
| summary | string | A short summary string about the catalog item. | | |
42-
| description | string | A description of the catalog item. | | |
43-
| runner | string | The container image to use when executing actions. | | ARM template </br> Terraform |
44-
| templatePath | string | The relative path of the entry template file. | Yes | main.tf </br> main.bicep </br> azuredeploy.json |
45-
| parameters | array | Input parameters to use when creating the environment and executing actions. | | #/definitions/Parameter |
38+
The following table describes the properties that you can use in manifest.yaml.
39+
40+
| Property | Type | Description | Required?|Example|
41+
| ------------ | -------- |------- | ------------ | ---------------- |
42+
| `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 |
4649

47-
## Parameters in environment.yaml
50+
## Parameters in manifest.yaml
4851

4952
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.
5053

51-
### Sample environment.yaml with parameters
54+
### Sample manifest.yaml with parameters
5255

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 manifest.yaml file that includes two parameters: `location` and `name`.
5457

5558
```yml
5659
name: WebApp
@@ -75,24 +78,24 @@ parameters:
7578

7679
### Parameter definitions
7780

78-
The following table describes the data types that you can use in environment.yaml. The data type names used in the environment.yaml manifest file differ from the ones used in ARM templates.
81+
The following table describes the data types that you can use in manifest.yaml. The data type names used in the manifest.yaml file differ from the ones used in ARM templates.
7982

8083
Each parameter can use any of the following properties:
8184

82-
| **Properties** | **Type** | **Description** | **Further Settings** |
83-
| -------------- | -------------- |------------------------------------------------ |--------------------------------------- |
84-
| ID | string | Unique ID of the parameter. | |
85-
| 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. | |
91-
| allowed | array | An array of allowed values. | "items": { </br> "type": "string" </br> }, </br> "minItems": 1, </br> "uniqueItems": true, |
85+
| Property| Type| Description | Additional settings |
86+
| ----| --- |---------------------- |-------------------- |
87+
| `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. | |
94+
| `allowed` | array | An array of allowed values. | "items": { </br> "type": "string" </br> }, </br> "minItems": 1, </br> "uniqueItems": true, |
9295

9396
## YAML schema
9497

95-
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 manifest.yaml files, which can make editing these files a little easier. You can add the schema definition to the beginning of your manifest.yaml file:
9699

97100
```yml
98101
# yaml-language-server: $schema=https://github.com/Azure/deployment-environments/releases/download/2022-11-11-preview/manifest.schema.json

0 commit comments

Comments
 (0)