Package version:

Interface FileTaskRunRequest

The request parameters for a scheduling run against a task file.

interface FileTaskRunRequest {
    agentConfiguration?: AgentProperties;
    agentPoolName?: string;
    credentials?: Credentials;
    isArchiveEnabled?: boolean;
    logTemplate?: string;
    platform: PlatformProperties;
    sourceLocation?: string;
    taskFilePath: string;
    timeout?: number;
    type: "FileTaskRunRequest";
    values?: SetValue[];
    valuesFilePath?: string;
}

Hierarchy (view full)

Properties

agentConfiguration? agentPoolName? credentials? isArchiveEnabled? logTemplate? platform sourceLocation? taskFilePath timeout? type values? valuesFilePath?

Properties

OptionalagentConfiguration

agentConfiguration?: AgentProperties

The machine configuration of the run agent.

OptionalagentPoolName

agentPoolName?: string

The dedicated agent pool for the run.

Optionalcredentials

credentials?: Credentials

The properties that describes a set of credentials that will be used when this run is invoked.

OptionalisArchiveEnabled

isArchiveEnabled?: boolean

The value that indicates whether archiving is enabled for the run or not.

OptionallogTemplate

logTemplate?: string

The template that describes the repository and tag information for run log artifact.

platform

platform: PlatformProperties

The platform properties against which the run has to happen.

OptionalsourceLocation

sourceLocation?: string

The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

taskFilePath

taskFilePath: string

The template/definition file path relative to the source.

Optionaltimeout

timeout?: number

Run timeout in seconds.

type

type

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

Optionalvalues

values?: SetValue[]

The collection of overridable values that can be passed when running a task.

OptionalvaluesFilePath

valuesFilePath?: string

The values/parameters file path relative to the source.

Settings

Member Visibility