BatchClient.DisableJob Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Overloads

DisableJob(String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext)	[Protocol Method] Disables the specified Job, preventing new Tasks from running. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DisableJob(String, BatchJobDisableContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken) convenience overload with strongly typed models first.
DisableJob(String, BatchJobDisableContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken)	Disables the specified Job, preventing new Tasks from running.

DisableJob(String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, RequestContext)

Source:

BatchClient.cs

[Protocol Method] Disables the specified Job, preventing new Tasks from running.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler DisableJob(String, BatchJobDisableContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response DisableJob (string jobId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, Azure.RequestContext context = default);

abstract member DisableJob : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> Azure.Response
override this.DisableJob : string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * Azure.RequestContext -> Azure.Response

Public Overridable Function DisableJob (jobId 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 Response

Parameters

jobId

String

The ID of the Job to disable.

content

RequestContent

The content to send as the body of the request.

timeOutInSeconds

Nullable<Int32>

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

Response

The response returned from the service.

Exceptions

ArgumentNullException

jobId or content is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DisableJob.

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
{
    disableTasks = "requeue",
});
Response response = client.DisableJob("<jobId>", content);

Console.WriteLine(response.Status);

This sample shows how to call DisableJob 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
{
    disableTasks = "requeue",
});
Response response = client.DisableJob("<jobId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);

Console.WriteLine(response.Status);

DisableJob(String, BatchJobDisableContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestConditions, CancellationToken)

Source:

BatchClient.cs

Disables the specified Job, preventing new Tasks from running.

public virtual Azure.Response DisableJob (string jobId, Azure.Compute.Batch.BatchJobDisableContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestConditions requestConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DisableJob : string * Azure.Compute.Batch.BatchJobDisableContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response
override this.DisableJob : string * Azure.Compute.Batch.BatchJobDisableContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestConditions * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DisableJob (jobId As String, content As BatchJobDisableContent, 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 Response

Parameters

jobId

String

The ID of the Job to disable.

content

BatchJobDisableContent

The options to use for disabling the Job.

timeOutInSeconds

Nullable<Int32>

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

Response

Exceptions

ArgumentNullException

jobId or content is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call DisableJob.

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

BatchJobDisableContent content = new BatchJobDisableContent(DisableBatchJobOption.Requeue);
Response response = client.DisableJob("<jobId>", content);

This sample shows how to call DisableJob with all parameters.

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

BatchJobDisableContent content = new BatchJobDisableContent(DisableBatchJobOption.Requeue);
Response response = client.DisableJob("<jobId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"), requestConditions: null);

Remarks

The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.