ComputeBatchModelFactory.BatchTask Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of BatchTask.
public static Azure.Compute.Batch.BatchTask BatchTask (string id = default, string displayName = default, string url = default, string eTag = default, DateTimeOffset? lastModified = default, DateTimeOffset? creationTime = default, Azure.Compute.Batch.ExitConditions exitConditions = default, Azure.Compute.Batch.BatchTaskState? state = default, DateTimeOffset? stateTransitionTime = default, Azure.Compute.Batch.BatchTaskState? previousState = default, DateTimeOffset? previousStateTransitionTime = default, string commandLine = default, Azure.Compute.Batch.BatchTaskContainerSettings containerSettings = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.ResourceFile> resourceFiles = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.OutputFile> outputFiles = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.EnvironmentSetting> environmentSettings = default, Azure.Compute.Batch.AffinityInfo affinityInfo = default, Azure.Compute.Batch.BatchTaskConstraints constraints = default, int? requiredSlots = default, Azure.Compute.Batch.UserIdentity userIdentity = default, Azure.Compute.Batch.BatchTaskExecutionInfo executionInfo = default, Azure.Compute.Batch.BatchNodeInfo nodeInfo = default, Azure.Compute.Batch.MultiInstanceSettings multiInstanceSettings = default, Azure.Compute.Batch.BatchTaskStatistics stats = default, Azure.Compute.Batch.BatchTaskDependencies dependsOn = default, System.Collections.Generic.IEnumerable<Azure.Compute.Batch.BatchApplicationPackageReference> applicationPackageReferences = default, Azure.Compute.Batch.AuthenticationTokenSettings authenticationTokenSettings = default);static member BatchTask : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.Compute.Batch.ExitConditions * Nullable<Azure.Compute.Batch.BatchTaskState> * Nullable<DateTimeOffset> * Nullable<Azure.Compute.Batch.BatchTaskState> * Nullable<DateTimeOffset> * string * Azure.Compute.Batch.BatchTaskContainerSettings * seq<Azure.Compute.Batch.ResourceFile> * seq<Azure.Compute.Batch.OutputFile> * seq<Azure.Compute.Batch.EnvironmentSetting> * Azure.Compute.Batch.AffinityInfo * Azure.Compute.Batch.BatchTaskConstraints * Nullable<int> * Azure.Compute.Batch.UserIdentity * Azure.Compute.Batch.BatchTaskExecutionInfo * Azure.Compute.Batch.BatchNodeInfo * Azure.Compute.Batch.MultiInstanceSettings * Azure.Compute.Batch.BatchTaskStatistics * Azure.Compute.Batch.BatchTaskDependencies * seq<Azure.Compute.Batch.BatchApplicationPackageReference> * Azure.Compute.Batch.AuthenticationTokenSettings -> Azure.Compute.Batch.BatchTaskPublic Shared Function BatchTask (Optional id As String = Nothing, Optional displayName As String = Nothing, Optional url As String = Nothing, Optional eTag As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional creationTime As Nullable(Of DateTimeOffset) = Nothing, Optional exitConditions As ExitConditions = Nothing, Optional state As Nullable(Of BatchTaskState) = Nothing, Optional stateTransitionTime As Nullable(Of DateTimeOffset) = Nothing, Optional previousState As Nullable(Of BatchTaskState) = Nothing, Optional previousStateTransitionTime As Nullable(Of DateTimeOffset) = Nothing, Optional commandLine As String = Nothing, Optional containerSettings As BatchTaskContainerSettings = Nothing, Optional resourceFiles As IEnumerable(Of ResourceFile) = Nothing, Optional outputFiles As IEnumerable(Of OutputFile) = Nothing, Optional environmentSettings As IEnumerable(Of EnvironmentSetting) = Nothing, Optional affinityInfo As AffinityInfo = Nothing, Optional constraints As BatchTaskConstraints = Nothing, Optional requiredSlots As Nullable(Of Integer) = Nothing, Optional userIdentity As UserIdentity = Nothing, Optional executionInfo As BatchTaskExecutionInfo = Nothing, Optional nodeInfo As BatchNodeInfo = Nothing, Optional multiInstanceSettings As MultiInstanceSettings = Nothing, Optional stats As BatchTaskStatistics = Nothing, Optional dependsOn As BatchTaskDependencies = Nothing, Optional applicationPackageReferences As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional authenticationTokenSettings As AuthenticationTokenSettings = Nothing) As BatchTaskParameters
- id
- String
A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
- displayName
- String
A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
- url
- String
The URL of the Task.
- eTag
- String
The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime.
- lastModified
- Nullable<DateTimeOffset>
The last modified time of the Task.
- creationTime
- Nullable<DateTimeOffset>
The creation time of the Task.
- exitConditions
- ExitConditions
How the Batch service should respond when the Task completes.
- state
- Nullable<BatchTaskState>
The current state of the Task.
- stateTransitionTime
- Nullable<DateTimeOffset>
The time at which the Task entered its current state.
- previousState
- Nullable<BatchTaskState>
The previous state of the Task. This property is not set if the Task is in its initial Active state.
- previousStateTransitionTime
- Nullable<DateTimeOffset>
The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state.
- commandLine
- String
The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
- containerSettings
- BatchTaskContainerSettings
The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
- resourceFiles
- IEnumerable<ResourceFile>
A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
- outputFiles
- IEnumerable<OutputFile>
A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.
- environmentSettings
- IEnumerable<EnvironmentSetting>
A list of environment variable settings for the Task.
- affinityInfo
- AffinityInfo
A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task.
- constraints
- BatchTaskConstraints
The execution constraints that apply to this Task.
The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1.
- userIdentity
- UserIdentity
The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task.
- executionInfo
- BatchTaskExecutionInfo
Information about the execution of the Task.
- nodeInfo
- BatchNodeInfo
Information about the Compute Node on which the Task ran.
- multiInstanceSettings
- MultiInstanceSettings
An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task.
- stats
- BatchTaskStatistics
Resource usage statistics for the Task.
- dependsOn
- BatchTaskDependencies
The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled.
- applicationPackageReferences
- IEnumerable<BatchApplicationPackageReference>
A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.
- authenticationTokenSettings
- AuthenticationTokenSettings
The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.
Returns
A new BatchTask instance for mocking.
Applies to
Azure SDK for .NET