Package version:

Interface Task

The task that has the ARM resource and task properties. The task will have all information to schedule a run against it.

interface Task {
    agentConfiguration?: AgentProperties;
    agentPoolName?: string;
    creationDate?: any;
    credentials?: Credentials;
    id?: string;
    identity?: IdentityProperties;
    isSystemTask?: boolean;
    location: string;
    logTemplate?: string;
    name?: string;
    platform?: PlatformProperties;
    provisioningState?: string;
    status?: string;
    step?: TaskStepPropertiesUnion;
    systemData?: SystemData;
    tags?: {
        [propertyName: string]: string;
    };
    timeout?: number;
    trigger?: TriggerProperties;
    type?: string;
}

Hierarchy (view full)

Properties

agentConfiguration? agentPoolName? creationDate? credentials? id? identity? isSystemTask? location logTemplate? name? platform? provisioningState? status? step? systemData? tags? timeout? trigger? type?

Properties

OptionalagentConfiguration

agentConfiguration?: AgentProperties

The machine configuration of the run agent.

OptionalagentPoolName

agentPoolName?: string

The dedicated agent pool for the task.

Optional ReadonlycreationDate

creationDate?: any

The creation date of task. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalcredentials

credentials?: Credentials

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

Optional Readonlyid

id?: string

The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalidentity

identity?: IdentityProperties

Identity for the resource.

OptionalisSystemTask

isSystemTask?: boolean

The value of this property indicates whether the task resource is system task or not.

location

location: string

The location of the resource. This cannot be changed after the resource is created.

OptionallogTemplate

logTemplate?: string

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

Optional Readonlyname

name?: string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalplatform

platform?: PlatformProperties

The platform properties against which the run has to happen.

Optional ReadonlyprovisioningState

provisioningState?: string

The provisioning state of the task. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalstatus

status?: string

The current status of task.

Optionalstep

step?: TaskStepPropertiesUnion

The properties of a task step.

Optional ReadonlysystemData

systemData?: SystemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optionaltags

tags?: {
    [propertyName: string]: string;
}

The tags of the resource.

Optionaltimeout

timeout?: number

Run timeout in seconds.

Optionaltrigger

trigger?: TriggerProperties

The properties that describe all triggers for the task.

Optional Readonlytype

type?: string

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility