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/configure-catalog-item.md
+59Lines changed: 59 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,65 @@ To add a catalog item:
86
86
87
87
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.
88
88
89
+
### Specify parameters for a catalog item
90
+
91
+
You can specify parameters for your catalog items to allow developers to customize their environments.
92
+
93
+
Parameters are defined in the manifest.yaml file. You can use the following options for parameters:
94
+
95
+
|Option |Description |
96
+
|---------|---------|
97
+
|ID |Enter an ID for the parameter.|
98
+
|name |Enter a name for the parameter.|
99
+
|description |Enter a description for the parameter.|
100
+
|default |Optional. Enter a default value for the parameter. The default value can be overwritten at creation.|
101
+
|type |Enter the data type for the parameter.|
102
+
|required|Enter `true` for a value that's required, and `false` for a value that's not required.|
103
+
104
+
The following script is an example of a *manifest.yaml* file that includes two parameters; `location` and `name`:
105
+
106
+
```YAML
107
+
name: WebApp
108
+
summary: Azure Web App Environment
109
+
description: Deploys a web app in Azure without a datastore
110
+
runner: ARM
111
+
templatePath: azuredeploy.json
112
+
parameters:
113
+
- id: "location"
114
+
name: "location"
115
+
description: "Location to deploy the environment resources"
116
+
default: "[resourceGroup().location]"
117
+
type: "string"
118
+
required: false
119
+
- id: "name"
120
+
name: "name"
121
+
description: "Name of the Web App "
122
+
default: ""
123
+
type: "string"
124
+
required: false
125
+
```
126
+
127
+
Developers can supply values for specific parameters for their environments through the developer portal.
128
+
129
+
:::image type="content" source="media/configure-catalog-item/parameters.png" alt-text="Screenshot showing the parameters pane.":::
130
+
131
+
Developers can also supply values for specific parameters for their environments through the CLI.
132
+
133
+
```azurecli
134
+
az devcenter dev environment create --catalog-item-name
135
+
--catalog-name
136
+
--dev-center
137
+
--environment-name
138
+
--environment-type
139
+
--project
140
+
[--description]
141
+
[--no-wait]
142
+
[--parameters]
143
+
[--tags]
144
+
[--user]
145
+
[--user-id]
146
+
```
147
+
Refer to the [Azure CLI devcenter extension](/cli/azure/devcenter/dev/environment) for full details of the `az devcenter dev environment create` command.
89
148
## Update a catalog item
90
149
91
150
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.
0 commit comments