IfConditionActivity Class

Definition

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

public class IfConditionActivity : Azure.ResourceManager.DataFactory.Models.ControlActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.IfConditionActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.IfConditionActivity>
public class IfConditionActivity : Azure.ResourceManager.DataFactory.Models.ControlActivity
type IfConditionActivity = class
    inherit ControlActivity
    interface IJsonModel<IfConditionActivity>
    interface IPersistableModel<IfConditionActivity>
type IfConditionActivity = class
    inherit ControlActivity
Public Class IfConditionActivity
Inherits ControlActivity
Implements IJsonModel(Of IfConditionActivity), IPersistableModel(Of IfConditionActivity)
Public Class IfConditionActivity
Inherits ControlActivity
Inheritance
Implements

Constructors

IfConditionActivity(String, DataFactoryExpression)

Initializes a new instance of IfConditionActivity.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from PipelineActivity)
DependsOn

Activity depends on condition.

(Inherited from PipelineActivity)
Description

Activity description.

(Inherited from PipelineActivity)
Expression

An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

IfFalseActivities

List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action. Please note PipelineActivity 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, DataLakeAnalyticsUsqlActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecuteWranglingDataflowActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetDatasetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, DataFactoryScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.

IfTrueActivities

List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action. Please note PipelineActivity 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, DataLakeAnalyticsUsqlActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecuteWranglingDataflowActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetDatasetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, DataFactoryScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.

Name

Activity name.

(Inherited from PipelineActivity)
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 PipelineActivity)
State

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

(Inherited from PipelineActivity)
UserProperties

Activity user properties.

(Inherited from PipelineActivity)

Explicit Interface Implementations

IJsonModel<ControlActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ControlActivity)
IJsonModel<ControlActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ControlActivity)
IJsonModel<IfConditionActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<IfConditionActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from PipelineActivity)
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from PipelineActivity)
IPersistableModel<ControlActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ControlActivity)
IPersistableModel<ControlActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ControlActivity)
IPersistableModel<ControlActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ControlActivity)
IPersistableModel<IfConditionActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<IfConditionActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<IfConditionActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from PipelineActivity)

Applies to