BatchClient.ReplaceTaskAsync 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.
Overloads
| ReplaceTaskAsync(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext) |
[Protocol Method] Updates the properties of the specified Task.
|
| ReplaceTaskAsync(String, String, BatchTask, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken) |
Updates the properties of the specified Task. |
ReplaceTaskAsync(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext)
- Source:
- BatchClientCustom.cs
[Protocol Method] Updates the properties of the specified Task.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler ReplaceTaskAsync(String, String, BatchTask, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> ReplaceTaskAsync (string jobId, string taskId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, Azure.RequestContext context = default);abstract member ReplaceTaskAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ReplaceTaskAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function ReplaceTaskAsync (jobId As String, taskId As String, content As RequestContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional requestConditions As RequestConditions = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)Parameters
- jobId
- String
The ID of the Job containing the Task.
- taskId
- String
The ID of the Task to update.
- content
- RequestContent
The content to send as the body of the request.
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
- ocpdate
- Nullable<DateTimeOffset>
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
- requestConditions
- RequestConditions
The content to send as the request conditions of the request.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
jobId, taskId or content is null.
jobId or taskId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call ReplaceTaskAsync.
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 object());
Response response = await client.ReplaceTaskAsync("<jobId>", "<taskId>", content);
Console.WriteLine(response.Status);
This sample shows how to call ReplaceTaskAsync 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
{
constraints = new
{
maxWallClockTime = "PT1H23M45S",
retentionTime = "PT1H23M45S",
maxTaskRetryCount = 1234,
},
});
Response response = await client.ReplaceTaskAsync("<jobId>", "<taskId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);
Console.WriteLine(response.Status);
Applies to
ReplaceTaskAsync(String, String, BatchTask, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken)
- Source:
- BatchClientCustom.cs
Updates the properties of the specified Task.
public virtual System.Threading.Tasks.Task<Azure.Response> ReplaceTaskAsync (string jobId, string taskId, Azure.Compute.Batch.BatchTask task, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceTaskAsync : string * string * Azure.Compute.Batch.BatchTask * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.ReplaceTaskAsync : string * string * Azure.Compute.Batch.BatchTask * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function ReplaceTaskAsync (jobId As String, taskId As String, task As BatchTask, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional requestConditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- jobId
- String
The ID of the Job containing the Task.
- taskId
- String
The ID of the Task to update.
- task
- BatchTask
The Task to update.
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
- ocpdate
- Nullable<DateTimeOffset>
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
- requestConditions
- RequestConditions
The content to send as the request conditions of the request.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
jobId, taskId or task is null.
jobId or taskId is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call ReplaceTaskAsync.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);
BatchTask task = new BatchTask();
Response response = await client.ReplaceTaskAsync("<jobId>", "<taskId>", task);
This sample shows how to call ReplaceTaskAsync with all parameters.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);
BatchTask task = new BatchTask
{
Constraints = new BatchTaskConstraints
{
MaxWallClockTime = XmlConvert.ToTimeSpan("PT1H23M45S"),
RetentionTime = XmlConvert.ToTimeSpan("PT1H23M45S"),
MaxTaskRetryCount = 1234,
},
};
Response response = await client.ReplaceTaskAsync("<jobId>", "<taskId>", task, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);
Applies to
Azure SDK for .NET