DigitalTwinsClient.UpdateAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

デジタル ツインを更新します。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.DigitalTwinUpdateResponse> UpdateAsync (string digitalTwinId, string jsonPatch, Microsoft.Azure.Devices.UpdateDigitalTwinOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function UpdateAsync (digitalTwinId As String, jsonPatch As String, Optional requestOptions As UpdateDigitalTwinOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DigitalTwinUpdateResponse)

パラメーター

digitalTwinId

String

デジタル ツインの ID。

jsonPatch

String

指定したデジタル ツインに対して実行される application/json-patch+json 操作。 このパッチは、 を使用して JsonPatchDocument構築できます。 詳細については、コード例を参照してください。

requestOptions

UpdateDigitalTwinOptions

この要求のオプションの設定。

cancellationToken

CancellationToken

cancellationToken。

戻り値

Task<DigitalTwinUpdateResponse>

デジタル ツインの新しい ETag とデジタル ツインの URI の場所。

例外

ArgumentNullException

指定 digitalTwinId された または jsonPatch が null の場合。

ArgumentException

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

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

例

string propertyName = "targetTemperature";int propertyValue = 12;var propertyValues = new Dictionary<string, object> { { propertyName, propertyValue } }; var patchDocument = new JsonPatchDocument(); patchDocument.AppendAdd("/myComponentName", propertyValues); string jsonPatch = patchDocument.ToString();DigitalTwinUpdateResponse updateResponse = await serviceClient.DigitalTwins.UpdateAsync(deviceId, jsonPatch);

注釈

json-patch を作成する方法の詳細については、「」を参照してください https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin。