ForEachActivity Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
ForEachActivity.cs

This activity is used for iterating over a collection and execute given activities.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ForEachActivity+ForEachActivityConverter))]
public class ForEachActivity : Azure.Analytics.Synapse.Artifacts.Models.ControlActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ForEachActivity+ForEachActivityConverter))>]
type ForEachActivity = class
    inherit ControlActivity
Public Class ForEachActivity
Inherits ControlActivity
Inheritance
Object
Activity
ControlActivity
ForEachActivity
Attributes
JsonConverterAttribute

Constructors

ForEachActivity(String, Expression, IEnumerable<Activity>)

Initializes a new instance of ForEachActivity.

Properties

Activities

List of activities to execute . Please note Activity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppendVariableActivity, AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, ControlActivity, CopyActivity, CustomActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DataLakeAnalyticsUsqlActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, ScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlPoolStoredProcedureActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.
AdditionalProperties

Additional Properties.

(Inherited from Activity)
BatchCount

Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
IsSequential

Should the loop be executed in sequence or in parallel (max 50).
Items

Collection to iterate.
Name

Activity name.

(Inherited from Activity)
OnInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

(Inherited from Activity)
State

Activity state. This is an optional property and if not provided, the state will be Active by default.

(Inherited from Activity)
UserProperties

Activity user properties.

(Inherited from Activity)

Applies to