Task Class

Definition

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.TaskTypeConverter))]
public class Task : Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.ITask, Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.TaskTypeConverter))>]
type Task = class
    interface ITask
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class Task
Implements ITask, IValidates
Inheritance
Task
Attributes
Implements

Constructors

Task()

Creates an new Task instance.

Properties

AgentConfigurationCpu

The CPU configuration in terms of number of cores required for the run.

AgentPoolName

The dedicated agent pool for the task.

BaseImageTriggerBaseImageTriggerType

The type of the auto trigger for base image dependency updates.

BaseImageTriggerName

The name of the trigger.

BaseImageTriggerStatus

The current status of trigger.

BaseImageTriggerUpdateTriggerEndpoint

The endpoint URL for receiving update triggers.

BaseImageTriggerUpdateTriggerPayloadType

Type of Payload body for Base image update triggers.

CreationDate

The creation date of task.

CredentialsCustomRegistry

Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry.

Id

The resource ID.

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The identity type.

IdentityUserAssignedIdentity

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IsSystemTask

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

Location

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

LogTemplate

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

Name

The name of the resource.

PlatformArchitecture

The OS architecture.

PlatformOS

The operating system type required for the run.

PlatformVariant

Variant of the CPU.

ProvisioningState

The provisioning state of the task.

ResourceGroupName

Gets the resource group name

SourceRegistryLoginMode

The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run.

Status

The current status of task.

StepBaseImageDependency

List of base image dependencies for a step.

StepContextAccessToken

The token (git PAT or SAS token of storage account blob) associated with the context for a step.

StepContextPath

The URL(absolute or relative) of the source context for the task step.

StepType

The type of the step.

SystemData

Metadata pertaining to creation and last modification of the resource.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource modification (UTC).

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

The tags of the resource.

Timeout

Run timeout in seconds.

TriggerSourceTrigger

The collection of triggers based on source code repository.

TriggerTimerTrigger

The collection of timer triggers.

Type

The type of the resource.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Task.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Task.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.ITask.

FromJsonString(String)

Creates a new instance of Task, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Task into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to