Skip to content

Commit 2e54645

Browse files
committed
Build fixes and updates
1 parent d7e0608 commit 2e54645

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,22 @@ The service scans the repository to find new catalog items. After you sync the r
8888

8989
### Specify parameters for a catalog item
9090

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.
9292

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
94107
name: WebApp
95108
summary: Azure Web App Environment
96109
description: Deploys a web app in Azure without a datastore
@@ -102,14 +115,13 @@ parameters:
102115
description: "Location to deploy the environment resources"
103116
default: "[resourceGroup().location]"
104117
type: "string"
118+
required: false
105119
- id: "name"
106120
name: "name"
107121
description: "Name of the Web App "
108122
default: ""
109123
type: "string"
110124
required: false
111-
112-
required: false
113125
```
114126

115127
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
132144
[--user]
133145
[--user-id]
134146
```
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.
136148
## Update a catalog item
137149

138150
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

Comments
 (0)