DigitalTwinsClient.UpdateAsync Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Paket:: Microsoft.Azure.Devices v2.0.0-preview002

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Updates einen digitalen Zwilling.

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)

Parameter

digitalTwinId: String

Die ID des digitalen Zwillings.

jsonPatch: String

Die application/json-patch+json-Vorgänge, die für den angegebenen digitalen Zwilling ausgeführt werden sollen. Dieser Patch kann mit JsonPatchDocumenterstellt werden. Weitere Details finden Sie im Beispielcode.

requestOptions: UpdateDigitalTwinOptions

Die optionalen Einstellungen für diese Anforderung.

cancellationToken: CancellationToken

Der cancellationToken.

Gibt zurück

Task<DigitalTwinUpdateResponse>

Das neue ETag für den digitalen Zwilling und den URI-Standort des digitalen Zwillings.

Ausnahmen

ArgumentNullException

Wenn das bereitgestellte digitalTwinId oder jsonPatch null ist.

ArgumentException

Wenn der bereitgestellte digitalTwinId oder jsonPatch leer oder leer ist.

IotHubServiceException

Wird ausgelöst, wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status-Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.

HttpRequestException

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.

OperationCanceledException

Wenn die bereitgestellte cancellationToken kündigung angefordert hat.

Beispiele

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);

Hinweise

Weitere Informationen zum Erstellen des JSON-Patches finden Sie unter https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin.

Gilt für:

Freigeben über