BatchClient.DeleteJob Method

Definition

Namespace:: Azure.Compute.Batch

Assembly:: Azure.Compute.Batch.dll

Package:: Azure.Compute.Batch v1.0.0-beta.3

Source:: BatchClientCustom.cs

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.

[Protocol Method] Deletes a Job.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Compute.Batch.DeleteJobOperation DeleteJob(string jobId, TimeSpan? timeOutInSeconds = default, DateTimeOffset? ocpDate = default, bool? force = default, Azure.RequestConditions requestConditions = default, Azure.RequestContext context = default);

abstract member DeleteJob : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<bool> * Azure.RequestConditions * Azure.RequestContext -> Azure.Compute.Batch.DeleteJobOperation
override this.DeleteJob : string * Nullable<TimeSpan> * Nullable<DateTimeOffset> * Nullable<bool> * Azure.RequestConditions * Azure.RequestContext -> Azure.Compute.Batch.DeleteJobOperation

Public Overridable Function DeleteJob (jobId As String, Optional timeOutInSeconds As Nullable(Of TimeSpan) = Nothing, Optional ocpDate As Nullable(Of DateTimeOffset) = Nothing, Optional force As Nullable(Of Boolean) = Nothing, Optional requestConditions As RequestConditions = Nothing, Optional context As RequestContext = Nothing) As DeleteJobOperation

Parameters

jobId: String

The ID of the Job to delete.

timeOutInSeconds: Nullable<TimeSpan>

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.