IJobOperations.DeleteWithHttpMessagesAsync メソッド

定義

名前空間:

Microsoft.Azure.Batch.Protocol

アセンブリ:

Microsoft.Azure.Batch.dll

パッケージ:

Microsoft.Azure.Batch v16.2.0

ソース:

IJobOperations.cs

ジョブを削除します。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobDeleteHeaders>> DeleteWithHttpMessagesAsync (string jobId, Microsoft.Azure.Batch.Protocol.Models.JobDeleteOptions jobDeleteOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobDeleteOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobDeleteHeaders>>

Public Function DeleteWithHttpMessagesAsync (jobId As String, Optional jobDeleteOptions As JobDeleteOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobDeleteHeaders))

パラメーター

jobId

String

削除するジョブの ID。

jobDeleteOptions

JobDeleteOptions

操作の追加パラメーター

customHeaders

Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationHeaderResponse<JobDeleteHeaders>>

例外

BatchErrorException

操作が無効な状態コードを返したときにスローされます

ValidationException

必須パラメーターが null の場合にスローされます

注釈

ジョブを削除すると、そのジョブの一部であるすべてのタスクと、すべてのジョブ統計も削除されます。 これにより、タスク データの保持期間もオーバーライドされます。つまり、ジョブにコンピューティング ノードに保持されているタスクがジョブに含まれている場合、Batch サービスはそれらのタスクの作業ディレクトリとそのすべての内容を削除します。 ジョブの削除要求を受信すると、Batch サービスはジョブを削除状態に設定します。 状態を削除中のジョブに対するすべての更新操作は、状態コード 409 (競合) で失敗し、ジョブが削除されていることを示す追加情報が表示されます。