JobScheduleOperationsExtensions.DeleteAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: JobScheduleOperationsExtensions.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.

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: String

The ID of the Job Schedule to delete.

jobScheduleDeleteOptions: JobScheduleDeleteOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

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