Package version:

Interface CustomActivity

Custom activity type.

interface CustomActivity {
    autoUserSpecification?: any;
    command: any;
    dependsOn?: ActivityDependency[];
    description?: string;
    extendedProperties?: {
        [propertyName: string]: any;
    };
    folderPath?: any;
    linkedServiceName?: LinkedServiceReference;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    referenceObjects?: CustomActivityReferenceObject;
    resourceLinkedService?: LinkedServiceReference;
    retentionTimeInDays?: any;
    state?: string;
    type: "Custom";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

autoUserSpecification? command dependsOn? description? extendedProperties? folderPath? linkedServiceName? name onInactiveMarkAs? policy? referenceObjects? resourceLinkedService? retentionTimeInDays? state? type userProperties?

Properties

OptionalautoUserSpecification

autoUserSpecification?: any

Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).

command

command: any

Command for custom activity Type: string (or Expression with resultType string).

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionalextendedProperties

extendedProperties?: {
    [propertyName: string]: any;
}

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.

OptionalfolderPath

folderPath?: any

Folder path for resource files Type: string (or Expression with resultType string).

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

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.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

OptionalreferenceObjects

referenceObjects?: CustomActivityReferenceObject

Reference objects

OptionalresourceLinkedService

resourceLinkedService?: LinkedServiceReference

Resource linked service reference.

OptionalretentionTimeInDays

retentionTimeInDays?: any

The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).

Optionalstate

state?: string

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

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility