DevicesClient.SetAsync メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.Devices

アセンブリ:: Microsoft.Azure.Devices.dll

パッケージ:: Microsoft.Azure.Devices v2.0.0-preview002

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

SetAsync(Device, Boolean, CancellationToken)	デバイス ID の状態を、指定されたデバイス ID の状態に置き換えます。
SetAsync(IEnumerable<Device>, Boolean, CancellationToken)	IoT ハブのレジストリ内の最大 100 個のデバイス ID を一括で更新します。

SetAsync(Device, Boolean, CancellationToken)

デバイス ID の状態を、指定されたデバイス ID の状態に置き換えます。

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

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

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

パラメーター

device: Device

デバイス ID の新しい状態。

onlyIfUnchanged: Boolean

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

cancellationToken: CancellationToken

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

戻り値

Task<Device>

新しい ETag を含む、新しく更新されたデバイス ID。

例外

ArgumentNullException

指定されたデバイスが null の場合。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

適用対象

SetAsync(IEnumerable<Device>, Boolean, CancellationToken)

IoT ハブのレジストリ内の最大 100 個のデバイス ID を一括で更新します。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> SetAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Device> devices, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function SetAsync (devices As IEnumerable(Of Device), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)