DigitalTwinsClient.UpdateAsync Método

Definição

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Pacote:

Microsoft.Azure.Devices v2.0.0-preview002

Atualizações um gêmeo digital.

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)

Parâmetros

digitalTwinId

String

A ID do gêmeo digital.

jsonPatch

String

As operações application/json-patch+json a serem executadas no gêmeo digital especificado. Esse patch pode ser construído usando JsonPatchDocument. Consulte o código de exemplo para obter mais detalhes.

requestOptions

UpdateDigitalTwinOptions

As configurações opcionais para essa solicitação.

cancellationToken

CancellationToken

O cancellationToken.

Retornos

Task<DigitalTwinUpdateResponse>

A nova ETag para o gêmeo digital e o local do URI do gêmeo digital.

Exceções

ArgumentNullException

Quando o fornecido digitalTwinId ou jsonPatch é nulo.

ArgumentException

Quando o fornecido digitalTwinId ou jsonPatch está vazio ou espaço em branco.

IotHubServiceException

Gerado se o Hub IoT respondeu à solicitação com um código de status não bem-sucedido. Por exemplo, se a solicitação fornecida foi limitada, IotHubServiceException com ThrottlingException é gerada. Para obter uma lista completa de possíveis casos de erro, consulte IotHubServiceErrorCode.

HttpRequestException

Se a solicitação HTTP falhar devido a um problema subjacente, como conectividade de rede, falha de DNS ou validação de certificado do servidor.

OperationCanceledException

Se o fornecido cancellationToken tiver solicitado o cancelamento.

Exemplos

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

Comentários

Para obter mais informações sobre como criar o json-patch, consulte https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin.