StartTask Constructors
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.
Overloads
| StartTask() |
Initializes a new instance of the StartTask class. |
| StartTask(String, TaskContainerSettings, IList<ResourceFile>, IList<EnvironmentSetting>, UserIdentity, Nullable<Int32>, Nullable<Boolean>) |
Initializes a new instance of the StartTask class. |
StartTask()
- Source:
- StartTask.cs
Initializes a new instance of the StartTask class.
public StartTask ();Public Sub New ()Applies to
StartTask(String, TaskContainerSettings, IList<ResourceFile>, IList<EnvironmentSetting>, UserIdentity, Nullable<Int32>, Nullable<Boolean>)
- Source:
- StartTask.cs
Initializes a new instance of the StartTask class.
public StartTask (string commandLine, Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings containerSettings = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile> resourceFiles = default, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> environmentSettings = default, Microsoft.Azure.Batch.Protocol.Models.UserIdentity userIdentity = default, int? maxTaskRetryCount = default, bool? waitForSuccess = default);new Microsoft.Azure.Batch.Protocol.Models.StartTask : string * Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ResourceFile> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.EnvironmentSetting> * Microsoft.Azure.Batch.Protocol.Models.UserIdentity * Nullable<int> * Nullable<bool> -> Microsoft.Azure.Batch.Protocol.Models.StartTaskPublic Sub New (commandLine As String, Optional containerSettings As TaskContainerSettings = Nothing, Optional resourceFiles As IList(Of ResourceFile) = Nothing, Optional environmentSettings As IList(Of EnvironmentSetting) = Nothing, Optional userIdentity As UserIdentity = Nothing, Optional maxTaskRetryCount As Nullable(Of Integer) = Nothing, Optional waitForSuccess As Nullable(Of Boolean) = Nothing)Parameters
- commandLine
- String
The command line of the StartTask.
- containerSettings
- TaskContainerSettings
The settings for the container under which the StartTask runs.
- resourceFiles
- IList<ResourceFile>
A list of files that the Batch service will download to the Compute Node before running the command line. 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.
- environmentSettings
- IList<EnvironmentSetting>
A list of environment variable settings for the StartTask.
- userIdentity
- UserIdentity
The user identity under which the StartTask runs.
Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node.
