Share via


Task Class

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Task(*, ___location: str, tags: Dict[str, str] | None = None, identity: _models.IdentityProperties | None = None, status: str | _models.TaskStatus | None = None, platform: _models.PlatformProperties | None = None, agent_configuration: _models.AgentProperties | None = None, agent_pool_name: str | None = None, timeout: int = 3600, step: _models.TaskStepProperties | None = None, trigger: _models.TriggerProperties | None = None, credentials: _models.Credentials | None = None, log_template: str | None = None, is_system_task: bool = False, **kwargs: Any)

Keyword-Only Parameters

Name Description
___location
str

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

tags

The tags of the resource.

Default value: None
identity

Identity for the resource.

Default value: None
status

The current status of task. Known values are: "Disabled" and "Enabled".

Default value: None
platform

The platform properties against which the run has to happen.

Default value: None
agent_configuration

The machine configuration of the run agent.

Default value: None
agent_pool_name
str

The dedicated agent pool for the task.

Default value: None
timeout
int

Run timeout in seconds.

Default value: 3600
step

The properties of a task step.

Default value: None
trigger

The properties that describe all triggers for the task.

Default value: None
credentials

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

Default value: None
log_template
str

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

Default value: None
is_system_task

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

Default value: False

Variables

Name Description
id
str

The resource ID.

name
str

The name of the resource.

type
str

The type of the resource.

___location
str

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

tags

The tags of the resource.

system_data

Metadata pertaining to creation and last modification of the resource.

identity

Identity for the resource.

provisioning_state

The provisioning state of the task. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".

creation_date

The creation date of task.

status

The current status of task. Known values are: "Disabled" and "Enabled".

platform

The platform properties against which the run has to happen.

agent_configuration

The machine configuration of the run agent.

agent_pool_name
str

The dedicated agent pool for the task.

timeout
int

Run timeout in seconds.

step

The properties of a task step.

trigger

The properties that describe all triggers for the task.

credentials

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

log_template
str

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

is_system_task

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