FailActivity Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

FailActivity.cs

This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FailActivity+FailActivityConverter))]
public class FailActivity : Azure.Analytics.Synapse.Artifacts.Models.ControlActivity

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FailActivity+FailActivityConverter))>]
type FailActivity = class
    inherit ControlActivity

Public Class FailActivity
Inherits ControlActivity

Inheritance

Object

Activity

ControlActivity

FailActivity

Attributes

JsonConverterAttribute

Constructors

FailActivity(String, Object, Object)

Initializes a new instance of FailActivity.

Properties

AdditionalProperties	Additional Properties. (Inherited from Activity)
DependsOn	Activity depends on condition. (Inherited from Activity)
Description	Activity description. (Inherited from Activity)
ErrorCode	The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
Message	The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
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)
State	Activity state. This is an optional property and if not provided, the state will be Active by default. (Inherited from Activity)
UserProperties	Activity user properties. (Inherited from Activity)