Share via


RunProperties interface

The properties for a run.

Properties

agentConfiguration

The machine configuration of the run agent.

agentPoolName

The dedicated agent pool for the run.

createTime

The time the run was scheduled.

customRegistries

The list of custom registries that were logged in during this run.

finishTime

The time the run finished.

imageUpdateTrigger

The image update trigger that caused the run. This is applicable if the task has base image trigger configured.

isArchiveEnabled

The value that indicates whether archiving is enabled or not.

lastUpdatedTime

The last updated time for the run.

logArtifact

The image description for the log artifact.

outputImages

The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.

platform

The platform properties against which the run will happen.

provisioningState

The provisioning state of a run.

runErrorMessage

The error message received from backend systems after the run is scheduled.

runId

The unique identifier for the run.

runType

The type of run.

sourceRegistryAuth

The scope of the credentials that were used to login to the source registry during this run.

sourceTrigger

The source trigger that caused the run.

startTime

The time the run started.

status

The current status of the run.

task

The task against which run was scheduled.

timerTrigger

The timer trigger that caused the run.

updateTriggerToken

The update trigger token passed for the Run.

Property Details

agentConfiguration

The machine configuration of the run agent.

agentConfiguration?: AgentProperties

Property Value

agentPoolName

The dedicated agent pool for the run.

agentPoolName?: string

Property Value

string

createTime

The time the run was scheduled.

createTime?: Date

Property Value

Date

customRegistries

The list of custom registries that were logged in during this run.

customRegistries?: string[]

Property Value

string[]

finishTime

The time the run finished.

finishTime?: Date

Property Value

Date

imageUpdateTrigger

The image update trigger that caused the run. This is applicable if the task has base image trigger configured.

imageUpdateTrigger?: ImageUpdateTrigger

Property Value

isArchiveEnabled

The value that indicates whether archiving is enabled or not.

isArchiveEnabled?: boolean

Property Value

boolean

lastUpdatedTime

The last updated time for the run.

lastUpdatedTime?: Date

Property Value

Date

logArtifact

The image description for the log artifact.

logArtifact?: ImageDescriptor

Property Value

outputImages

The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.

outputImages?: ImageDescriptor[]

Property Value

platform

The platform properties against which the run will happen.

platform?: PlatformProperties

Property Value

provisioningState

The provisioning state of a run.

provisioningState?: string

Property Value

string

runErrorMessage

The error message received from backend systems after the run is scheduled.

runErrorMessage?: string

Property Value

string

runId

The unique identifier for the run.

runId?: string

Property Value

string

runType

The type of run.

runType?: string

Property Value

string

sourceRegistryAuth

The scope of the credentials that were used to login to the source registry during this run.

sourceRegistryAuth?: string

Property Value

string

sourceTrigger

The source trigger that caused the run.

sourceTrigger?: SourceTriggerDescriptor

Property Value

startTime

The time the run started.

startTime?: Date

Property Value

Date

status

The current status of the run.

status?: string

Property Value

string

task

The task against which run was scheduled.

task?: string

Property Value

string

timerTrigger

The timer trigger that caused the run.

timerTrigger?: TimerTriggerDescriptor

Property Value

updateTriggerToken

The update trigger token passed for the Run.

updateTriggerToken?: string

Property Value

string