CustomActivity Class

Reference

Definition

Namespace:: Azure.ResourceManager.DataFactory.Models

Assembly:: Azure.ResourceManager.DataFactory.dll

Package:: Azure.ResourceManager.DataFactory v1.5.0

Package:: Azure.ResourceManager.DataFactory v1.0.0-beta.6

Source:: CustomActivity.cs

Source:: CustomActivity.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Custom activity type.

public class CustomActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CustomActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CustomActivity>

public class CustomActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity

type CustomActivity = class
    inherit ExecutionActivity
    interface IJsonModel<CustomActivity>
    interface IPersistableModel<CustomActivity>

type CustomActivity = class
    inherit ExecutionActivity

Public Class CustomActivity
Inherits ExecutionActivity
Implements IJsonModel(Of CustomActivity), IPersistableModel(Of CustomActivity)

Public Class CustomActivity
Inherits ExecutionActivity

Inheritance: Object

PipelineActivity

ExecutionActivity
CustomActivity

Implements: IJsonModel<CustomActivity> IPersistableModel<CustomActivity> IPersistableModel<T>

Constructors

CustomActivity(String, DataFactoryElement<String>)

Initializes a new instance of CustomActivity.

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)
AutoUserSpecification	Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).
Command	Command for custom activity Type: string (or Expression with resultType string).
DependsOn	Activity depends on condition. (Inherited from PipelineActivity)
Description	Activity description. (Inherited from PipelineActivity)
ExtendedProperties	User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined. 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" }.
FolderPath	Folder path for resource files Type: string (or Expression with resultType string).
LinkedServiceName	Linked service reference. (Inherited from ExecutionActivity)
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)
Policy	Activity policy. (Inherited from ExecutionActivity)
ReferenceObjects	Reference objects.
ResourceLinkedService	Resource linked service reference.
RetentionTimeInDays	The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double). To assign an object to 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" }.
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)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)	(Inherited from ExecutionActivity)

Explicit Interface Implementations

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

Share via