Share via


CustomActivity Class

Definition

Custom activity type.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CustomActivity+CustomActivityConverter))]
public class CustomActivity : Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CustomActivity+CustomActivityConverter))>]
type CustomActivity = class
    inherit ExecutionActivity
Public Class CustomActivity
Inherits ExecutionActivity
Inheritance
Attributes

Constructors

CustomActivity(String, Object)

Initializes a new instance of CustomActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
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 Activity)
Description

Activity description.

(Inherited from Activity)
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.

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 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)
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).

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