Share via

CustomActivity interface

  • Reference
Package:
@azure/arm-datafactory

Custom activity type.

Extends
ExecutionActivity

Properties

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

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

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
linkedServiceName

Linked service reference.
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.
policy

Activity policy.
state

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

Activity user properties.

Property Details

autoUserSpecification

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

autoUserSpecification?: any

Property Value

any

command

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

command: any

Property Value

any

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.

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

Property Value

{[propertyName: string]: any}

folderPath

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

folderPath?: any

Property Value

any

referenceObjects

Reference objects

referenceObjects?: CustomActivityReferenceObject

Property Value

CustomActivityReferenceObject

resourceLinkedService

Resource linked service reference.

resourceLinkedService?: LinkedServiceReference

Property Value

LinkedServiceReference

retentionTimeInDays

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

retentionTimeInDays?: any

Property Value

any

type

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

type: "Custom"

Property Value

"Custom"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.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.

onInactiveMarkAs?: string

Property Value

string

Inherited From ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

state

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

state?: string

Property Value

string

Inherited From ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties