DigitalTwinsClient.UpdateAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Mises à jour un jumeau numérique.

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)

Paramètres

digitalTwinId: String

ID du jumeau numérique.

jsonPatch: String

Opérations application/json-patch+json à effectuer sur le jumeau numérique spécifié. Ce correctif peut être construit à l’aide de JsonPatchDocument. Pour plus d’informations, consultez l’exemple de code.

requestOptions: UpdateDigitalTwinOptions

Paramètres facultatifs pour cette demande.

cancellationToken: CancellationToken

CancellationToken.

Retours

Task<DigitalTwinUpdateResponse>

Nouveau ETag pour le jumeau numérique et l’emplacement URI du jumeau numérique.

Exceptions

ArgumentNullException

Lorsque le fourni digitalTwinId ou jsonPatch a la valeur null.

ArgumentException

Lorsque le fourni digitalTwinId ou jsonPatch est vide ou espace blanc.

IotHubServiceException

Levée si IoT Hub a répondu à la demande avec un code de status non réussi. Par exemple, si la requête fournie a été limitée, IotHubServiceException avec ThrottlingException est levée. Pour obtenir la liste complète des cas d’erreur possibles, consultez IotHubServiceErrorCode.

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le fourni cancellationToken a demandé l’annulation.

Exemples

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

Remarques

Pour plus d’informations sur la création du json-patch, consultez https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin.

S’applique à

Partager via