FileTaskRunRequest interface
The request parameters for a scheduling run against a task file.
- Extends
Properties
agent |
The machine configuration of the run agent. |
credentials | The properties that describes a set of credentials that will be used when this run is invoked. |
platform | The platform properties against which the run has to happen. |
source |
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. |
task |
The template/definition file path relative to the source. |
timeout | Run timeout in seconds. |
type | Polymorphic discriminator, which specifies the different types this object can be |
values | The collection of overridable values that can be passed when running a task. |
values |
The values/parameters file path relative to the source. |
Inherited Properties
agent |
The dedicated agent pool for the run. |
is |
The value that indicates whether archiving is enabled for the run or not. |
log |
The template that describes the repository and tag information for run log artifact. |
Property Details
agentConfiguration
The machine configuration of the run agent.
agentConfiguration?: AgentProperties
Property Value
credentials
The properties that describes a set of credentials that will be used when this run is invoked.
credentials?: Credentials
Property Value
platform
The platform properties against which the run has to happen.
platform: PlatformProperties
Property Value
sourceLocation
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.
sourceLocation?: string
Property Value
string
taskFilePath
The template/definition file path relative to the source.
taskFilePath: string
Property Value
string
timeout
Run timeout in seconds.
timeout?: number
Property Value
number
type
Polymorphic discriminator, which specifies the different types this object can be
type: "FileTaskRunRequest"
Property Value
"FileTaskRunRequest"
values
The collection of overridable values that can be passed when running a task.
values?: SetValue[]
Property Value
SetValue[]
valuesFilePath
The values/parameters file path relative to the source.
valuesFilePath?: string
Property Value
string
Inherited Property Details
agentPoolName
The dedicated agent pool for the run.
agentPoolName?: string
Property Value
string
Inherited From RunRequest.agentPoolName
isArchiveEnabled
The value that indicates whether archiving is enabled for the run or not.
isArchiveEnabled?: boolean
Property Value
boolean
Inherited From RunRequest.isArchiveEnabled
logTemplate
The template that describes the repository and tag information for run log artifact.
logTemplate?: string
Property Value
string
Inherited From RunRequest.logTemplate