CloudTask Class

Definition

An Azure Batch task. A task is a piece of work that is associated with a job and runs on a compute node.

public class CloudTask : Microsoft.Azure.Batch.IInheritedBehaviors, Microsoft.Azure.Batch.IRefreshable
type CloudTask = class
    interface IRefreshable
    interface ITransportObjectProvider<TaskAddParameter>
    interface IInheritedBehaviors
    interface IPropertyMetadata
    interface IModifiable
    interface IReadOnly
Public Class CloudTask
Implements IInheritedBehaviors, IRefreshable
Inheritance
System.Object
CloudTask
Implements

Constructors

CloudTask(String, String)

Initializes a new instance of the CloudTask class.

Properties

AffinityInformation

Gets or sets a locality hint that can be used by the Batch service to select a node on which to start the task.

ApplicationPackageReferences

Gets or sets a list of application packages that the Batch service will deploy to the compute node before running the command line.

AuthenticationTokenSettings

Gets or sets the settings for an authentication token that the task can use to perform Batch service operations.

CommandLine

Gets or sets the command line of the task.

ComputeNodeInformation

Gets information about the compute node on which the task ran.

Constraints

Gets or sets the execution constraints that apply to this task.

ContainerSettings

Gets or sets the settings for the container under which the task runs.

CreationTime

Gets the creation time of the task.

CustomBehaviors

Gets or sets a list of behaviors that modify or customize requests to the Batch service made via this CloudTask.

DependsOn

Gets or sets any other tasks that this CloudTask depends on. The task will not be scheduled until all depended-on tasks have completed successfully.

DisplayName

Gets or sets the display name of the task.

EnvironmentSettings

Gets or sets a list of environment variable settings for the task.

ETag

Gets the ETag for the task.

ExecutionInformation

Gets the execution information for the task.

ExitConditions

Gets or sets how the Batch service should respond when the task completes.

FilesToStage

Gets or sets a list of files to be staged for the task.

Id

Gets or sets the id of the task.

LastModified

Gets the last modified time of the task.

MultiInstanceSettings

Gets or sets information about how to run the multi-instance task.

OutputFiles

Gets or sets a list of files that the Batch service will upload from the compute node after running the command line.

PreviousState

Gets the previous state of the task.

PreviousStateTransitionTime

Gets the time at which the task entered its previous state.

ResourceFiles

Gets or sets a list of files that the Batch service will download to the compute node before running the command line.

State

Gets the current state of the task.

StateTransitionTime

Gets the time at which the task entered its current state.

Statistics

Gets resource usage statistics for the task.

Url

Gets the URL of the task.

UserIdentity

Gets or sets the user identity under which the task runs.

Methods

Commit(IEnumerable<BatchClientBehavior>)

Commits all pending changes to this CloudTask to the Azure Batch service.

CommitAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Commits all pending changes to this CloudTask to the Azure Batch service.

Delete(IEnumerable<BatchClientBehavior>)

Deletes this CloudTask.

DeleteAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Deletes this CloudTask.

GetNodeFile(String, IEnumerable<BatchClientBehavior>)

Gets the specified NodeFile from the CloudTask's directory on its compute node.

GetNodeFileAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Gets the specified NodeFile from the CloudTask's directory on its compute node.

ListNodeFiles(Nullable<Boolean>, DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the files in the CloudTask's directory on its compute node.

ListSubtasks(DetailLevel, IEnumerable<BatchClientBehavior>)

Enumerates the subtasks of the multi-instance CloudTask.

Reactivate(IEnumerable<BatchClientBehavior>)

Reactivates this CloudTask, allowing it to run again even if its retry count has been exhausted.

ReactivateAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Reactivates this CloudTask, allowing it to run again even if its retry count has been exhausted.

Refresh(DetailLevel, IEnumerable<BatchClientBehavior>)

Refreshes the current CloudTask.

RefreshAsync(DetailLevel, IEnumerable<BatchClientBehavior>, CancellationToken)

Refreshes the current CloudTask.

StageFiles()

Stages the files listed in the FilesToStage list.

StageFilesAsync(ConcurrentDictionary<Type,IFileStagingArtifact>)

Stages the files listed in the FilesToStage list.

Terminate(IEnumerable<BatchClientBehavior>)

Terminates this CloudTask, marking it as completed.

TerminateAsync(IEnumerable<BatchClientBehavior>, CancellationToken)

Terminates this CloudTask, marking it as completed.

Extension Methods

OutputStorage(CloudTask, CloudStorageAccount)

Gets the TaskOutputStorage for a specified CloudTask.

Applies to