DeleteActivity Class

Definition

Delete activity.

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

Constructors

DeleteActivity(String, DatasetReference)

Initializes a new instance of DeleteActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
Dataset

Delete activity dataset reference.

DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
EnableLogging

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

LinkedServiceName

Linked service reference.

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

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

State

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

(Inherited from Activity)
StoreSettings

Delete activity store settings. Please note StoreReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings, AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings, LakeHouseReadSettings and SftpReadSettings.

UserProperties

Activity user properties.

(Inherited from Activity)

Applies to