IJobOperations.TerminateWithHttpMessagesAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Batch.Protocol

Ensamblado:

Microsoft.Azure.Batch.dll

Paquete:

Microsoft.Azure.Batch v16.2.0

Source:

IJobOperations.cs

Finaliza el trabajo especificado y lo marca como completado.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders>> TerminateWithHttpMessagesAsync (string jobId, string terminateReason = default, Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions jobTerminateOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member TerminateWithHttpMessagesAsync : string * string * Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions * 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.JobTerminateHeaders>>

Public Function TerminateWithHttpMessagesAsync (jobId As String, Optional terminateReason As String = Nothing, Optional jobTerminateOptions As JobTerminateOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobTerminateHeaders))

Parámetros

jobId

String

Identificador del trabajo que se va a finalizar.

terminateReason

String

El texto que desea que aparezca como TerminateReason del trabajo. El valor predeterminado es "UserTerminate".

jobTerminateOptions

JobTerminateOptions

Parámetros adicionales para la operación

customHeaders

Dictionary<String,List<String>>

Encabezados que se agregarán a la solicitud.

cancellationToken

CancellationToken

Token de cancelación.

Devoluciones

Task<AzureOperationHeaderResponse<JobTerminateHeaders>>

Excepciones

BatchErrorException

Se produce cuando la operación devolvió un código de estado no válido

ValidationException

Se produce cuando un parámetro obligatorio es NULL

Comentarios

Cuando se recibe una solicitud finalizar trabajo, el servicio Batch establece el trabajo en el estado de finalización. A continuación, el servicio Batch finaliza las tareas en ejecución asociadas al trabajo y ejecuta las tareas de lanzamiento de trabajos necesarias. A continuación, el trabajo pasa al estado completado. Si hay alguna tarea en el trabajo en estado activo, permanecerá en el estado activo. Una vez finalizado un trabajo, no se pueden agregar nuevas tareas y no se programarán las tareas activas restantes.