ScheduledJobsClient.CancelAsync(String, CancellationToken) Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Paket:: Microsoft.Azure.Devices v2.0.0-preview002

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bricht den Auftrag mit der angegebenen ID ab/löscht sie.

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)

Parameter

jobId: String

ID des abzubrechenden Auftrags.

cancellationToken: CancellationToken

Vorgangsabbruchtoken.

Gibt zurück

Task<ScheduledJob>

Ein Auftragsobjekt

Ausnahmen

ArgumentNullException

Wenn das bereitgestellte jobId null ist.

ArgumentException

Wenn leer jobId oder leer ist.

IotHubServiceException

Wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.

HttpRequestException

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.

OperationCanceledException

Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.

Gilt für:

Freigeben über