PipelineActivity Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

PipelineActivity.cs

A pipeline activity. 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, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DataLakeAnalyticsUsqlActivity, 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.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.DataFactory.Models.UnknownActivity))]
public abstract class PipelineActivity : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.PipelineActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.PipelineActivity>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.DataFactory.Models.UnknownActivity))>]
type PipelineActivity = class
    interface IJsonModel<PipelineActivity>
    interface IPersistableModel<PipelineActivity>

Public MustInherit Class PipelineActivity
Implements IJsonModel(Of PipelineActivity), IPersistableModel(Of PipelineActivity)

Inheritance

Object

PipelineActivity

Derived

Azure.ResourceManager.DataFactory.Models.ControlActivity

Azure.ResourceManager.DataFactory.Models.ExecuteWranglingDataflowActivity

Azure.ResourceManager.DataFactory.Models.ExecutionActivity

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<PipelineActivity> IPersistableModel<PipelineActivity> IPersistableModel<T>

Constructors

PipelineActivity(String)

Initializes a new instance of PipelineActivity.

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" }.
DependsOn	Activity depends on condition.
Description	Activity description.
Name	Activity name.
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.
State	Activity state. This is an optional property and if not provided, the state will be Active by default.
UserProperties	Activity user properties.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.