TwinsClient.ReplaceAsync メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.Devices

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

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

重要

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

オーバーロード

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)	デバイスのツインの変更可能なフィールドを更新します。
ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)	モジュールのツインの変更可能なフィールドを更新します。

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)

デバイスのツインの変更可能なフィールドを更新します。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> ReplaceAsync(string deviceId, Microsoft.Azure.Devices.ClientTwin newTwin, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.ReplaceAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function ReplaceAsync (deviceId As String, newTwin As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

パラメーター

deviceId: String

デバイス ID。

newTwin: ClientTwin

置き換える新しいツインオブジェクト。

onlyIfUnchanged: Boolean

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

cancellationToken: CancellationToken

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

戻り値

Task<ClientTwin>

更新されたツイン。

例外

ArgumentNullException

指定 deviceId されたまたは newTwin が null の場合。

ArgumentException

指定 deviceId されたが空または空白の場合。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

適用対象

ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)

モジュールのツインの変更可能なフィールドを更新します。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> ReplaceAsync(string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin newTwin, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.ReplaceAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function ReplaceAsync (deviceId As String, moduleId As String, newTwin As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

パラメーター

deviceId: String

デバイス ID。

moduleId: String

モジュール ID。

newTwin: ClientTwin

置き換える新しい Twin オブジェクト。

onlyIfUnchanged: Boolean

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