ScheduledJobsClient.CancelAsync(String, CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Paquet:

Microsoft.Azure.Devices v2.0.0-preview002

Annule/supprime le travail avec l’ID spécifié.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob> CancelAsync (string jobId, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
override this.CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>

Public Overridable Function CancelAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ScheduledJob)

Paramètres

jobId

String

ID du travail à annuler.

cancellationToken

CancellationToken

Jeton d’annulation de tâche.

Retours

Task<ScheduledJob>

Objet de travail

Exceptions

ArgumentNullException

Lorsque le fourni jobId a la valeur Null.

ArgumentException

Si est jobId vide ou espace blanc.

IotHubServiceException

Si IoT Hub a répondu à la demande avec un code de status non réussi. Par exemple, si la requête fournie a été limitée, IotHubServiceException avec ThrottlingException est levée. Pour obtenir la liste complète des cas d’erreur possibles, consultez IotHubServiceErrorCode.

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le fourni cancellationToken a demandé l’annulation.