ScheduledJobsClient.CancelAsync(String, CancellationToken) メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

指定した ID を持つジョブを取り消す/削除します。

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)

パラメーター

jobId

String

取り消すジョブの ID。

cancellationToken

CancellationToken

タスクの取り消しトークン。

戻り値

Task<ScheduledJob>

ジョブ オブジェクト

例外

ArgumentNullException

指定 jobId された が null の場合。

ArgumentException

jobIdが空または空白の場合。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合。 たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。 考えられるエラー ケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。