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
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,9 +88,22 @@ The service scans the repository to find new catalog items. After you sync the r
88
88
89
89
### Specify parameters for a catalog item
90
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.
91
+
You can specify parameters for your catalog items to allow developers to customize their environments.
92
92
93
-
```yml
93
+
Parameters are specified in the manifest.yaml file. You can use the following options for the 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` or `false` to specify whether the value is required or not.|
103
+
104
+
The following script is an example of a *manifest.yaml* file that includes two parameters; `location` and `name`:
105
+
106
+
```YAML
94
107
name: WebApp
95
108
summary: Azure Web App Environment
96
109
description: Deploys a web app in Azure without a datastore
@@ -102,14 +115,13 @@ parameters:
102
115
description: "Location to deploy the environment resources"
103
116
default: "[resourceGroup().location]"
104
117
type: "string"
118
+
required: false
105
119
- id: "name"
106
120
name: "name"
107
121
description: "Name of the Web App "
108
122
default: ""
109
123
type: "string"
110
124
required: false
111
-
112
-
required: false
113
125
```
114
126
115
127
Developers can supply values for specific parameters for their environments through the developer portal.
@@ -132,7 +144,7 @@ az devcenter dev environment create --catalog-item-name
132
144
[--user]
133
145
[--user-id]
134
146
```
135
-
Refer to the [Azure CLI devcenter extension](/cli/azure/devcenter/dev/environment?view=azure-cli-latest) for full details.
147
+
Refer to the [Azure CLI devcenter extension](/cli/azure/devcenter/dev/environment) for full details.
136
148
## Update a catalog item
137
149
138
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