BatchClient.CreateTaskAsync Method

Source:

BatchClientCustom.cs

public virtual System.Threading.Tasks.Task<Azure.Response> CreateTaskAsync (string jobId, Azure.Compute.Batch.BatchTaskCreateContent task, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateTaskAsync : string * Azure.Compute.Batch.BatchTaskCreateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateTaskAsync : string * Azure.Compute.Batch.BatchTaskCreateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateTaskAsync (jobId As String, task As BatchTaskCreateContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

Returns

Exceptions

Examples

This sample shows how to call CreateTaskAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

BatchTaskCreateContent task = new BatchTaskCreateContent("<id>", "<commandLine>");
Response response = await client.CreateTaskAsync("<jobId>", task);

This sample shows how to call CreateTaskAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

BatchTaskCreateContent task = new BatchTaskCreateContent("<id>", "<commandLine>")
{
    DisplayName = "<displayName>",
    ExitConditions = new ExitConditions
    {
        ExitCodes = {new ExitCodeMapping(1234, new ExitOptions
        {
            JobAction = BatchJobAction.None,
            DependencyAction = DependencyAction.Satisfy,
        })},
        ExitCodeRanges = { new ExitCodeRangeMapping(1234, 1234, default) },
        PreProcessingError = default,
        FileUploadError = default,
        Default = default,
    },
    ContainerSettings = new BatchTaskContainerSettings("<imageName>")
    {
        ContainerRunOptions = "<containerRunOptions>",
        Registry = new ContainerRegistryReference
        {
            Username = "<username>",
            Password = "<password>",
            RegistryServer = "<registryServer>",
            IdentityReference = new BatchNodeIdentityReference
            {
                ResourceId = "<resourceId>",
            },
        },
        WorkingDirectory = ContainerWorkingDirectory.TaskWorkingDirectory,
    },
    ResourceFiles = {new ResourceFile
    {
        AutoStorageContainerName = "<autoStorageContainerName>",
        StorageContainerUrl = "<storageContainerUrl>",
        HttpUrl = "<httpUrl>",
        BlobPrefix = "<blobPrefix>",
        FilePath = "<filePath>",
        FileMode = "<fileMode>",
        IdentityReference = default,
    }},
    OutputFiles = {new OutputFile("<filePattern>", new OutputFileDestination
    {
        Container = new OutputFileBlobContainerDestination("<containerUrl>")
        {
            Path = "<path>",
            IdentityReference = default,
            UploadHeaders = {new HttpHeader("<name>")
            {
                Value = "<value>",
            }},
        },
    }, new OutputFileUploadConfig(OutputFileUploadCondition.TaskSuccess))},
    EnvironmentSettings = {new EnvironmentSetting("<name>")
    {
        Value = "<value>",
    }},
    AffinityInfo = new AffinityInfo("<affinityId>"),
    Constraints = new BatchTaskConstraints
    {
        MaxWallClockTime = XmlConvert.ToTimeSpan("PT1H23M45S"),
        RetentionTime = XmlConvert.ToTimeSpan("PT1H23M45S"),
        MaxTaskRetryCount = 1234,
    },
    RequiredSlots = 1234,
    UserIdentity = new UserIdentity
    {
        Username = "<username>",
        AutoUser = new AutoUserSpecification
        {
            Scope = AutoUserScope.Task,
            ElevationLevel = ElevationLevel.NonAdmin,
        },
    },
    MultiInstanceSettings = new MultiInstanceSettings("<coordinationCommandLine>")
    {
        NumberOfInstances = 1234,
        CommonResourceFiles = { default },
    },
    DependsOn = new BatchTaskDependencies
    {
        TaskIds = { "<taskIds>" },
        TaskIdRanges = { new BatchTaskIdRange(1234, 1234) },
    },
    ApplicationPackageReferences = {new BatchApplicationPackageReference("<applicationId>")
    {
        Version = "<version>",
    }},
    AuthenticationTokenSettings = new AuthenticationTokenSettings
    {
        Access = { AccessScope.Job },
    },
};
Response response = await client.CreateTaskAsync("<jobId>", task, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Remarks

The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

Source:

BatchClientCustom.cs

public virtual System.Threading.Tasks.Task<Azure.Response> CreateTaskAsync (string jobId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestContext context = default);

abstract member CreateTaskAsync : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateTaskAsync : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateTaskAsync (jobId As String, content As RequestContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

Returns

The response returned from the service.

Exceptions

Examples

This sample shows how to call CreateTaskAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    id = "<id>",
    commandLine = "<commandLine>",
});
Response response = await client.CreateTaskAsync("<jobId>", content);

Console.WriteLine(response.Status);

This sample shows how to call CreateTaskAsync with all parameters and request content.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    id = "<id>",
    displayName = "<displayName>",
    exitConditions = new Dictionary<string, object>
    {
        ["exitCodes"] = new object[]
        {
            new
            {
                code = 1234,
                exitOptions = new
                {
                    jobAction = "none",
                    dependencyAction = "satisfy",
                },
            }
        },
        ["exitCodeRanges"] = new object[]
        {
            new
            {
                start = 1234,
                end = 1234,
            }
        },
        ["preProcessingError"] = null,
        ["fileUploadError"] = null,
        ["default"] = null
    },
    commandLine = "<commandLine>",
    containerSettings = new
    {
        containerRunOptions = "<containerRunOptions>",
        imageName = "<imageName>",
        registry = new
        {
            username = "<username>",
            password = "<password>",
            registryServer = "<registryServer>",
            identityReference = new
            {
                resourceId = "<resourceId>",
            },
        },
        workingDirectory = "taskWorkingDirectory",
    },
    resourceFiles = new object[]
    {
        new
        {
            autoStorageContainerName = "<autoStorageContainerName>",
            storageContainerUrl = "<storageContainerUrl>",
            httpUrl = "<httpUrl>",
            blobPrefix = "<blobPrefix>",
            filePath = "<filePath>",
            fileMode = "<fileMode>",
        }
    },
    outputFiles = new object[]
    {
        new
        {
            filePattern = "<filePattern>",
            destination = new
            {
                container = new
                {
                    path = "<path>",
                    containerUrl = "<containerUrl>",
                    uploadHeaders = new object[]
                    {
                        new
                        {
                            name = "<name>",
                            value = "<value>",
                        }
                    },
                },
            },
            uploadOptions = new
            {
                uploadCondition = "tasksuccess",
            },
        }
    },
    environmentSettings = new object[]
    {
        new
        {
            name = "<name>",
            value = "<value>",
        }
    },
    affinityInfo = new
    {
        affinityId = "<affinityId>",
    },
    constraints = new
    {
        maxWallClockTime = "PT1H23M45S",
        retentionTime = "PT1H23M45S",
        maxTaskRetryCount = 1234,
    },
    requiredSlots = 1234,
    userIdentity = new
    {
        username = "<username>",
        autoUser = new
        {
            scope = "task",
            elevationLevel = "nonadmin",
        },
    },
    multiInstanceSettings = new
    {
        numberOfInstances = 1234,
        coordinationCommandLine = "<coordinationCommandLine>",
        commonResourceFiles = new object[]
        {
            null
        },
    },
    dependsOn = new
    {
        taskIds = new object[]
        {
            "<taskIds>"
        },
        taskIdRanges = new object[]
        {
            new
            {
                start = 1234,
                end = 1234,
            }
        },
    },
    applicationPackageReferences = new object[]
    {
        new
        {
            applicationId = "<applicationId>",
            version = "<version>",
        }
    },
    authenticationTokenSettings = new
    {
        access = new object[]
        {
            "job"
        },
    },
});
Response response = await client.CreateTaskAsync("<jobId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Console.WriteLine(response.Status);