Merge pull request #7752 from MicrosoftDocs/users/jukullam/stringlist-addition

Adding stringList examples

Author: prmerger-automator[bot]

docs/pipelines/process/includes/parameter-data-types.md

@@ -8,9 +8,13 @@ ms.date: 08/30/2024
 ai-usage: ai-assisted
 ---
 
+> [!IMPORTANT]
+>  The new stringList data type feature will roll out over the next month. 
+
 | Data type | Notes |
 |-----------|-------|
 | `string` | string
+| `stringList` | a list of items, multiple can be selected. Not available in templates
 | `number` | may be restricted to `values:`, otherwise any number-like string is accepted
 | `boolean` | `true` or `false`
 | `object` | any YAML structure
@@ -23,7 +27,10 @@ ai-usage: ai-assisted
 | `stage` | a single stage
 | `stageList` | sequence of stages
 
-The step, stepList, job, jobList, deployment, deploymentList, stage, and stageList data types all use standard YAML schema format. This example includes string, number, boolean, object, step, and stepList. 
+The `step`, `stepList`, `job`, `jobList`, `deployment`, `deploymentList`, `stage`, `stringList`, and `stageList` data types all use standard YAML schema format. This example includes `string`, `number`, `boolean`, `object`, `step`, and `stepList`. 
+
+> [!NOTE]
+> The `stringList` data type isn't available in templates. Use the `object` data type in templates instead.
 
 ```yaml
 parameters:
@@ -33,11 +40,22 @@ parameters:
 
 - name: myMultiString  # Define a parameter named 'myMultiString'
   type: string  # The parameter type is string
-  default: default  # Default value is 'default'
+  default: default  # Default value is 'default', only one default
   values:  # Allowed values for 'myMultiString'
   - default  
   - ubuntu  
 
+- name: myStringlist # Define a parameter named 'myStringlist'
+  type: stringList # The parameter type is stringList
+  displayName: Regions
+  values: # Allowed values for 'myStringlist'
+    - WUS
+    - CUS
+    - EUS
+  default: # Default values
+    - WUS
+    - CUS
+    
 - name: myNumber  # Define a parameter named 'myNumber'
   type: number  # The parameter type is number
   default: 2  # Default value is 2
@@ -76,7 +94,7 @@ parameters:
   default:  # Default value is a list of steps
     - script: echo step one  
     - script: echo step two  
-
+    
 trigger: none  
 
 jobs: 
@@ -86,4 +104,9 @@ jobs:
 - job: myStep  # Define a job named 'myStep'
   steps:
     - ${{ parameters.myStep }}  # Use the step from the 'myStep' parameter
+
+- job: stringList  # Define a job named 'stringList'
+  steps:
+  - ${{ each region in parameters.myStringlist }}:
+      - script: echo ${{region}}
 ```

docs/pipelines/process/template-expressions.md

@@ -317,6 +317,36 @@ jobs:
       - script: echo So will this!
 ```
 
+You can also use `stringList` to define and interate over parameters that contain a list of items. 
+
+> [!NOTE]
+> The `stringList` data type isn't available in templates. Use the `object` data type in templates instead.
+
+
+```yaml
+parameters:
+- name: regions
+  type: stringList
+  displayName: Regions
+  values:
+    - WUS
+    - CUS
+    - EUS
+  default: 
+    - WUS
+    - EUS 
+
+stages:
+- ${{ each stage in parameters.regions}}:
+  - stage: ${{stage}}
+    displayName: Deploy to ${{stage}}
+    jobs:
+    - job:
+      steps:
+      - script: ./deploy ${{stage}}
+```
+
+
 You can also manipulate the properties of whatever you're iterating over.
 For example, to add more dependencies: