Package version:

Interface ExecuteSsisPackageActivity

Execute SSIS package activity.

interface ExecuteSsisPackageActivity {
    connectVia: IntegrationRuntimeReference;
    dependsOn?: ActivityDependency[];
    description?: string;
    environmentPath?: any;
    executionCredential?: SsisExecutionCredential;
    linkedServiceName?: LinkedServiceReference;
    loggingLevel?: any;
    logLocation?: SsisLogLocation;
    name: string;
    onInactiveMarkAs?: string;
    packageConnectionManagers?: {
        [propertyName: string]: {
            [propertyName: string]: SsisExecutionParameter;
        };
    };
    packageLocation: SsisPackageLocation;
    packageParameters?: {
        [propertyName: string]: SsisExecutionParameter;
    };
    policy?: ActivityPolicy;
    projectConnectionManagers?: {
        [propertyName: string]: {
            [propertyName: string]: SsisExecutionParameter;
        };
    };
    projectParameters?: {
        [propertyName: string]: SsisExecutionParameter;
    };
    propertyOverrides?: {
        [propertyName: string]: SsisPropertyOverride;
    };
    runtime?: any;
    state?: string;
    type: "ExecuteSSISPackage";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

connectVia dependsOn? description? environmentPath? executionCredential? linkedServiceName? loggingLevel? logLocation? name onInactiveMarkAs? packageConnectionManagers? packageLocation packageParameters? policy? projectConnectionManagers? projectParameters? propertyOverrides? runtime? state? type userProperties?

Properties

connectVia

connectVia: IntegrationRuntimeReference

The integration runtime reference.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionalenvironmentPath

environmentPath?: any

The environment path to execute the SSIS package. Type: string (or Expression with resultType string).

OptionalexecutionCredential

executionCredential?: SsisExecutionCredential

The package execution credential.

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

OptionalloggingLevel

loggingLevel?: any

The logging level of SSIS package execution. Type: string (or Expression with resultType string).

OptionallogLocation

logLocation?: SsisLogLocation

SSIS package execution log location.

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.

OptionalpackageConnectionManagers

packageConnectionManagers?: {
    [propertyName: string]: {
        [propertyName: string]: SsisExecutionParameter;
    };
}

The package level connection managers to execute the SSIS package.

packageLocation

packageLocation: SsisPackageLocation

SSIS package location.

OptionalpackageParameters

packageParameters?: {
    [propertyName: string]: SsisExecutionParameter;
}

The package level parameters to execute the SSIS package.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

OptionalprojectConnectionManagers

projectConnectionManagers?: {
    [propertyName: string]: {
        [propertyName: string]: SsisExecutionParameter;
    };
}

The project level connection managers to execute the SSIS package.

OptionalprojectParameters

projectParameters?: {
    [propertyName: string]: SsisExecutionParameter;
}

The project level parameters to execute the SSIS package.

OptionalpropertyOverrides

propertyOverrides?: {
    [propertyName: string]: SsisPropertyOverride;
}

The property overrides to execute the SSIS package.

Optionalruntime

runtime?: any

Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).

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.

Settings

Member Visibility