ModulesClient.SetAsync(Module, Boolean, CancellationToken) メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

モジュール ID の状態を、指定されたモジュール ID の状態に置き換えます。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module> SetAsync (Microsoft.Azure.Devices.Module module, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>
override this.SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>

Public Overridable Function SetAsync (module As Module, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Module)

パラメーター

module

Module

モジュール ID の新しい状態。

onlyIfUnchanged

Boolean

false の場合、指定されたデバイス ID に古い ETag がある場合でも、この操作が実行されます。 true の場合、指定されたモジュールに古い ETag がある場合、操作は with PreconditionFailed をスローIotHubServiceExceptionします。 を使用して GetAsync(String, String, CancellationToken)、最新の ETag を取得できます。

cancellationToken

CancellationToken

操作を取り消すトークン。

戻り値

Task<Module>

新しく更新されたモジュール ID (新しい ETag を含む)。

例外

ArgumentNullException

指定されたモジュールが null の場合にスローされます。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

指定されたキャンセル トークンが取り消しを要求した場合。