Interface TaskAgent

A task agent.

interface TaskAgent {
    _links?: any;
    accessPoint?: string;
    assignedAgentCloudRequest?: TaskAgentCloudRequest;
    assignedRequest?: TaskAgentJobRequest;
    authorization?: TaskAgentAuthorization;
    createdOn?: Date;
    enabled?: boolean;
    id?: number;
    lastCompletedRequest?: TaskAgentJobRequest;
    maxParallelism?: number;
    name?: string;
    oSDescription?: string;
    pendingUpdate?: TaskAgentUpdate;
    properties?: any;
    provisioningState?: string;
    status?: TaskAgentStatus;
    statusChangedOn?: Date;
    systemCapabilities?: { [key: string]: string };
    userCapabilities?: { [key: string]: string };
    version?: string;
}

Hierarchy (View Summary)

Properties

_links? accessPoint? assignedAgentCloudRequest? assignedRequest? authorization? createdOn? enabled? id? lastCompletedRequest? maxParallelism? name? oSDescription? pendingUpdate? properties? provisioningState? status? statusChangedOn? systemCapabilities? userCapabilities? version?

Properties

Optional_links

_links?: any

OptionalaccessPoint

accessPoint?: string

This agent's access point.

OptionalassignedAgentCloudRequest

assignedAgentCloudRequest?: TaskAgentCloudRequest

The agent cloud request that's currently associated with this agent.

OptionalassignedRequest

assignedRequest?: TaskAgentJobRequest

The request which is currently assigned to this agent.

Optionalauthorization

authorization?: TaskAgentAuthorization

Authorization information for this agent.

OptionalcreatedOn

createdOn?: Date

Date on which this agent was created.

Optionalenabled

enabled?: boolean

Whether or not this agent should run jobs.

Optionalid

id?: number

Identifier of the agent.

OptionallastCompletedRequest

lastCompletedRequest?: TaskAgentJobRequest

The last request which was completed by this agent.

OptionalmaxParallelism

maxParallelism?: number

Maximum job parallelism allowed for this agent.

Optionalname

name?: string

Name of the agent.

OptionaloSDescription

oSDescription?: string

Agent OS.

OptionalpendingUpdate

pendingUpdate?: TaskAgentUpdate

Pending update for this agent.

Optionalproperties

properties?: any

OptionalprovisioningState

provisioningState?: string

Provisioning state of this agent.

Optionalstatus

status?: TaskAgentStatus

Whether or not the agent is online.

OptionalstatusChangedOn

statusChangedOn?: Date

Date on which the last connectivity status change occurred.

OptionalsystemCapabilities

systemCapabilities?: { [key: string]: string }

System-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.

OptionaluserCapabilities

userCapabilities?: { [key: string]: string }

User-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.

Optionalversion

version?: string

Agent version.

Settings

Member Visibility

On This Page

Properties