Share via

Task interface

Package:
@azure/arm-containerregistry

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

Extends
TrackedResource

Properties

agentConfiguration

The machine configuration of the run agent.
agentPoolName

The dedicated agent pool for the task.
creationDate

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

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

Identity for the resource.
isSystemTask

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

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

The platform properties against which the run has to happen.
provisioningState

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

The current status of task.
step

The properties of a task step.
timeout

Run timeout in seconds.
trigger

The properties that describe all triggers for the task.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

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

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

agentConfiguration

The machine configuration of the run agent.

agentConfiguration?: AgentProperties

Property Value

AgentProperties

agentPoolName

The dedicated agent pool for the task.

agentPoolName?: string

Property Value

string

creationDate

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

creationDate?: Date

Property Value

Date

credentials

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

credentials?: Credentials

Property Value

Credentials

identity

Identity for the resource.

identity?: IdentityProperties

Property Value

IdentityProperties

isSystemTask

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

isSystemTask?: boolean

Property Value

boolean

logTemplate

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

logTemplate?: string

Property Value

string

platform

The platform properties against which the run has to happen.

platform?: PlatformProperties

Property Value

PlatformProperties

provisioningState

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

provisioningState?: string

Property Value

string

status

The current status of task.

status?: string

Property Value

string

step

The properties of a task step.

step?: TaskStepPropertiesUnion

Property Value

TaskStepPropertiesUnion

timeout

Run timeout in seconds.

timeout?: number

Property Value

number

trigger

The properties that describe all triggers for the task.

trigger?: TriggerProperties

Property Value

TriggerProperties

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type