JobScheduleOperationsExtensions.DeleteAsync Method

Definition

Deletes a Job Schedule from the specified Account.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDeleteHeaders> DeleteAsync (this Microsoft.Azure.Batch.Protocol.IJobScheduleOperations operations, string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobScheduleDeleteOptions jobScheduleDeleteOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member DeleteAsync : Microsoft.Azure.Batch.Protocol.IJobScheduleOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobScheduleDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleDeleteHeaders>
<Extension()>
Public Function DeleteAsync (operations As IJobScheduleOperations, jobScheduleId As String, Optional jobScheduleDeleteOptions As JobScheduleDeleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobScheduleDeleteHeaders)

Parameters

operations
IJobScheduleOperations

The operations group for this extension method.

jobScheduleId
System.String

The ID of the Job Schedule to delete.

jobScheduleDeleteOptions
JobScheduleDeleteOptions

Additional parameters for the operation

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<JobScheduleDeleteHeaders>

Remarks

When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.

Applies to