DeleteActivity Class

Definition

Delete activity.

public class DeleteActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.DeleteActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.DeleteActivity>
public class DeleteActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity
type DeleteActivity = class
    inherit ExecutionActivity
    interface IJsonModel<DeleteActivity>
    interface IPersistableModel<DeleteActivity>
type DeleteActivity = class
    inherit ExecutionActivity
Public Class DeleteActivity
Inherits ExecutionActivity
Implements IJsonModel(Of DeleteActivity), IPersistableModel(Of DeleteActivity)
Public Class DeleteActivity
Inherits ExecutionActivity
Inheritance
Implements

Constructors

DeleteActivity(String, DatasetReference)

Initializes a new instance of DeleteActivity.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from PipelineActivity)
Dataset

Delete activity dataset reference.

DependsOn

Activity depends on condition.

(Inherited from PipelineActivity)
Description

Activity description.

(Inherited from PipelineActivity)
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 PipelineActivity)
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 PipelineActivity)
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 PipelineActivity)
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 AmazonS3CompatibleReadSettings, AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings, AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings, LakeHouseReadSettings, OracleCloudStorageReadSettings and SftpReadSettings.

UserProperties

Activity user properties.

(Inherited from PipelineActivity)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ExecutionActivity)

Explicit Interface Implementations

IJsonModel<DeleteActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DeleteActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ExecutionActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ExecutionActivity)
IJsonModel<ExecutionActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ExecutionActivity)
IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from PipelineActivity)
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from PipelineActivity)
IPersistableModel<DeleteActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DeleteActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DeleteActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ExecutionActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ExecutionActivity)
IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from PipelineActivity)

Applies to