Merge pull request #227629 from n0elleli/pipelinedocupdate

Pipelinedocupdate

Author: v-dirichards

articles/data-factory/control-flow-set-variable-activity.md

@@ -1,12 +1,12 @@
 ---
 title: Set Variable Activity
 titleSuffix: Azure Data Factory & Azure Synapse
-description: Learn how to use the Set Variable activity to set the value of an existing variable defined in an Azure Data Factory or Azure Synapse Analytics pipeline.
+description: Learn how to use the Set Variable activity to set the value of an existing variable defined in an Azure Data Factory or Azure Synapse Analytics pipeline or to set a pipeline return value. 
 ms.service: data-factory
 ms.subservice: orchestration
 ms.custom: synapse
 ms.topic: conceptual
-ms.date: 10/24/2022
+ms.date: 02/16/2023
 author: chez-charlie
 ms.author: chez
 ms.reviewer: jburchel
@@ -15,19 +15,43 @@ ms.reviewer: jburchel
 # Set Variable Activity in Azure Data Factory and Azure Synapse Analytics
 [!INCLUDE[appliesto-adf-asa-md](includes/appliesto-adf-asa-md.md)]
 
-Use the Set Variable activity to set the value of an existing variable of type String, Bool, or Array defined in a Data Factory or Synapse pipeline.
+Use the Set Variable activity to set the value of an existing variable of type String, Bool, or Array defined in a Data Factory or Synapse pipeline or use the Set Variable activity to set a pipeline return value (preview).
 
-## Create an Append Variable activity with UI
+## Create a Set Variable activity with UI
 
 To use a Set Variable activity in a pipeline, complete the following steps:
+
 1. Select the background of the pipeline canvas and use the Variables tab to add a variable:
-:::image type="content" source="media/control-flow-activities-common/add-pipeline-array-variable.png" alt-text="Screenshot shows an empty pipeline canvas with the variables tab selected having an array type variable named TestVariable.":::
+
+:::image type="content" source="media/control-flow-activities-common/add-pipeline-array-variable.png" alt-text="Screenshot of an empty pipeline canvas with the Variables tab selected with an array type variable named TestVariable.":::
+
+2. Search for _Set Variable_ in the pipeline Activities pane, and drag a Set Variable activity to the pipeline canvas.
+
+3. Select the Set Variable activity on the canvas if it isn't already selected, and then click the **Settings** tab to edit its details.
+
+4. Select the variable for the Name property.
+
+5. Enter an expression to set the value for the variables. This expression can be a literal string expression, or any combination of dynamic [expressions, functions](control-flow-expression-language-functions.md), [system variables](control-flow-system-variables.md), or [outputs from other activities](how-to-expression-language-functions.md#examples-of-using-parameters-in-expressions).
+
+:::image type="content" source="media/control-flow-set-variable-activity/set-variable-activity.png" alt-text="Screenshot of the UI for a Set variable activity.":::
+    
+## Setting a pipeline return value in the Set Variable activity with UI
+
+The Set Variable activity now allows you to set a pipeline return value (preview). The pipeline return value is a system variable that allows you to customize a value that can be consumed by a parent pipeline and used downstream in your pipeline. 
+
+To set a pipeline return value, complete the following steps:
 
 1. Search for _Set Variable_ in the pipeline Activities pane, and drag a Set Variable activity to the pipeline canvas.
-1. Select the Set Variable activity on the canvas if it is not already selected, and its **Variables** tab, to edit its details.
-1. Select the variable for the Name property.
-1. Enter an expression to set the value for the variables. This expression can be a literal string expression, or any combination of dynamic [expressions, functions](control-flow-expression-language-functions.md), [system variables](control-flow-system-variables.md), or [outputs from other activities](how-to-expression-language-functions.md#examples-of-using-parameters-in-expressions).
-:::image type="content" source="media/control-flow-set-variable-activity/set-variable-activity.png" alt-text="Screenshot shows the ui for a set variable activity.":::
+
+2. Select the Set Variable activity on the canvas if it isn't already selected, and then click the **Settings** tab to edit its details.
+
+3. Select **Pipeline return value (preview)** for your **Variable type**.
+
+4. Enter a **Name** for your variable and select the **Type** from the drop-down menu. 
+
+5. Enter an expression to set the value for the pipeline return value. This expression can be a literal string expression, or any combination of dynamic [expressions, functions](control-flow-expression-language-functions.md), [system variables](control-flow-system-variables.md), or [outputs from other activities](how-to-expression-language-functions.md#examples-of-using-parameters-in-expressions).
+
+:::image type="content" source="media/control-flow-set-variable-activity/set-pipeline-return-value.png" alt-text="Screenshot of the UI for setting a pipeline return value.":::
 
 ## Type properties
 
@@ -36,13 +60,16 @@ Property | Description | Required
 name | Name of the activity in pipeline | yes
 description | Text describing what the activity does | no
 type | Must be set to **SetVariable** | yes
-value | String literal or expression object value that the variable is assigned to | yes
 variableName | Name of the variable that is set by this activity | yes
+value | String literal or expression object value that the variable is assigned to | yes
+
 
 ## Incrementing a variable
 
-A common scenario involving variables is using a variable as an iterator within an until or foreach activity. In a set variable activity, you cannot reference the variable being set in the `value` field. To work around this limitation, set a temporary variable and then create a second set variable activity. The second set variable activity sets the value of the iterator to the temporary variable. 
+A common scenario involving variables is to use a variable as an iterator within an **Until** or **ForEach** activity. In a **Set variable** activity, you can't reference the variable being set in the `value` field. To work around this limitation, set a temporary variable and then create a second **Set variable** activity. The second **Set variable** activity sets the value of the iterator to the temporary variable. 
+
 Below is an example of this pattern:
+
 :::image type="content" source="media/control-flow-set-variable-activity/increment-variable.png" alt-text="Screenshot shows increment variable.":::
 
 ``` json
@@ -99,10 +126,10 @@ Below is an example of this pattern:
 }
 ```
 
-Variables are currently scoped at the pipeline level. This means that they are not thread safe and can cause unexpected and undesired behavior if they are accessed from within a parallel iteration activity such as a foreach loop, especially when the value is also being modified within that foreach activity.
+Variables are currently scoped at the pipeline level. This means that they're not thread safe and can cause unexpected and undesired behavior if they are accessed from within a parallel iteration activity such as a ForEach loop, especially when the value is also being modified within that foreach activity.
+
 
 ## Next steps
 Learn about another related control flow activity: 
-
 - [Append Variable Activity](control-flow-append-variable-activity.md)