TwinsClient.UpdateAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

オーバーロード

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)	システム内で以前に作成したモジュール ツインの一覧の変更可能なフィールドを更新します。
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)	モジュールのツインの変更可能なフィールドを更新します。
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)	モジュールのツインの変更可能なフィールドを更新します。

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)

システム内で以前に作成したモジュール ツインの一覧の変更可能なフィールドを更新します。

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

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

Public Overridable Function UpdateAsync (twins As IEnumerable(Of ClientTwin), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

パラメーター

twins

IEnumerable<ClientTwin>

更新されたフィールドを ClientTwin含む の一覧。

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

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

戻り値

Task<BulkRegistryOperationResult>

更新されたモジュール ツイン。

例外

ArgumentNullException

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

ArgumentException

指定 twins された列挙が空の場合。

InvalidOperationException

ツインに予期される ETag がない場合。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

UpdateAsync(String, ClientTwin, Boolean, CancellationToken)

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

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

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

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

パラメーター

deviceId

String

デバイス ID。

twinPatch

ClientTwin

更新されたフィールドを持つツイン。

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

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

戻り値

Task<ClientTwin>

デバイス ツインを更新しました。

例外

ArgumentNullException

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

ArgumentException

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

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)

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

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

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

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

パラメーター

deviceId

String

デバイス ID。

moduleId

String

モジュール ID。

twinPatch

ClientTwin

更新されたフィールドを持つツイン。

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

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

戻り値

Task<ClientTwin>

デバイス ツインを更新しました。

例外

ArgumentNullException

指定 deviceIdされた 、、 moduleIdまたは twinPatch が null の場合。

ArgumentException

または moduleId がdeviceId空または空白の場合。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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