Package version:

Interface SetVariableActivity

Set value for a Variable.

interface SetVariableActivity {
    dependsOn?: ActivityDependency[];
    description?: string;
    name: string;
    onInactiveMarkAs?: string;
    policy?: SecureInputOutputPolicy;
    setSystemVariable?: boolean;
    state?: string;
    type: "SetVariable";
    userProperties?: UserProperty[];
    value?: any;
    variableName?: string;
}

Hierarchy (view full)

Properties

dependsOn? description? name onInactiveMarkAs? policy? setSystemVariable? state? type userProperties? value? variableName?

Properties

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

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.

Optionalpolicy

policy?: SecureInputOutputPolicy

Activity policy.

OptionalsetSystemVariable

setSystemVariable?: boolean

If set to true, it sets the pipeline run return value.

Optionalstate

state?: string

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

type

type

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

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Optionalvalue

value?: any

Value to be set. Could be a static value or Expression.

OptionalvariableName

variableName?: string

Name of the variable whose value needs to be set.

Settings

Member Visibility