Skip to content

Commit d7e0608

Browse files
committed
ADE- manage environment - added parameters section
1 parent 9863d89 commit d7e0608

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

articles/deployment-environments/configure-catalog-item.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,53 @@ To add a catalog item:
8686

8787
The service scans the repository to find new catalog items. After you sync the repository, new catalog items are available to all projects in the dev center.
8888

89+
### Specify parameters for a catalog item
90+
91+
Catalog items can use parameters to allow developers to customize their environments. Parameters are specified in the manifest.yaml file. You can define a default value for a parameter that the developer creating the environment can overwrite. The following script shows two parameters; `location` and `name`. Location has a default value of `[resourceGroup().location]`, which sets the location of the environment to the location of the resource group.
92+
93+
```yml
94+
name: WebApp
95+
summary: Azure Web App Environment
96+
description: Deploys a web app in Azure without a datastore
97+
runner: ARM
98+
templatePath: azuredeploy.json
99+
parameters:
100+
- id: "location"
101+
name: "location"
102+
description: "Location to deploy the environment resources"
103+
default: "[resourceGroup().location]"
104+
type: "string"
105+
- id: "name"
106+
name: "name"
107+
description: "Name of the Web App "
108+
default: ""
109+
type: "string"
110+
required: false
111+
112+
required: false
113+
```
114+
115+
Developers can supply values for specific parameters for their environments through the developer portal.
116+
117+
:::image type="content" source="media/configure-catalog-item/parameters.png" alt-text="Screenshot showing the parameters pane.":::
118+
119+
Developers can also supply values for specific parameters for their environments through the CLI.
120+
121+
```azurecli
122+
az devcenter dev environment create --catalog-item-name
123+
--catalog-name
124+
--dev-center
125+
--environment-name
126+
--environment-type
127+
--project
128+
[--description]
129+
[--no-wait]
130+
[--parameters]
131+
[--tags]
132+
[--user]
133+
[--user-id]
134+
```
135+
Refer to the [Azure CLI devcenter extension](/cli/azure/devcenter/dev/environment?view=azure-cli-latest) for full details.
89136
## Update a catalog item
90137

91138
To modify the configuration of Azure resources in an existing catalog item, update the associated ARM template JSON file in the repository. The change is immediately reflected when you create a new environment by using the specific catalog item. The update also is applied when you redeploy an environment that's associated with that catalog item.
13.3 KB
Loading

0 commit comments

Comments
 (0)