DeleteActivity interface

Package:
@azure/arm-datafactory

Delete activity.

Extends
ExecutionActivity

Properties

dataset

Delete activity dataset reference.
enableLogging

Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).
logStorageSettings

Log storage settings customer need to provide when enableLogging is true.
maxConcurrentConnections

The max concurrent connections to connect data source at the same time.
recursive

If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).
storeSettings

Delete activity store settings.
type

Type of activity.

Inherited Properties

additionalProperties

Additional 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

dataset

Delete activity dataset reference.

dataset: DatasetReference

Property Value

DatasetReference

enableLogging

Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).

enableLogging?: any

Property Value

any

logStorageSettings

Log storage settings customer need to provide when enableLogging is true.

logStorageSettings?: LogStorageSettings

Property Value

LogStorageSettings

maxConcurrentConnections

The max concurrent connections to connect data source at the same time.

maxConcurrentConnections?: number

Property Value

number

recursive

If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).

recursive?: any

Property Value

any

storeSettings

Delete activity store settings.

storeSettings?: StoreReadSettingsUnion

Property Value

StoreReadSettingsUnion

type

Type of activity.

type: "Delete"

Property Value

"Delete"

Inherited Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

Inherited From ExecutionActivity.additionalProperties

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