TwinsClient.ReplaceAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)	Atualizações os campos mutáveis do gêmeo de um dispositivo.
ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)	Atualizações os campos mutáveis do gêmeo de um módulo.

ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)

Atualizações os campos mutáveis do gêmeo de um dispositivo.

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

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

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

Parâmetros

deviceId: String

A ID do dispositivo.

newTwin: ClientTwin

Novo objeto gêmeo pelo qual substituir.

onlyIfUnchanged: Boolean

Se for false, essa operação será executada mesmo se a identidade do dispositivo fornecida tiver uma ETag desatualizada. Se for true, a operação gerará um IotHubServiceException com PreconditionFailed se a identidade do dispositivo fornecida tiver uma ETag desatualizada. Uma ETag atualizada pode ser recuperada usando GetAsync(String, String, CancellationToken).

cancellationToken: CancellationToken

Token de cancelamento de tarefa.

Retornos

Task<ClientTwin>

gêmeos atualizados.

Exceções

ArgumentNullException

Quando o fornecido deviceId ou newTwin é nulo.

ArgumentException

Quando o fornecido deviceId estiver vazio ou espaço em branco.

IotHubServiceException

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.

Aplica-se a

ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)

Atualizações os campos mutáveis do gêmeo de um módulo.

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

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

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

Parâmetros

deviceId: String

A ID do dispositivo.

moduleId: String

A ID do módulo.

newTwin: ClientTwin

Novo objeto Gêmeo pelo qual substituir.

onlyIfUnchanged: Boolean

Se for false, essa operação será executada mesmo se a identidade do dispositivo fornecida tiver uma ETag desatualizada. Se for true, a operação gerará um IotHubServiceException com PreconditionFailed se a identidade do dispositivo/módulo fornecida tiver uma ETag desatualizada. Uma ETag atualizada pode ser recuperada usando GetAsync(String, String, CancellationToken).